AI Agents

The following endpoints allow you to get, create, update, delete, and run AI Agents. These endpoints are available in open beta to all users. As beta endpoints, both functionality and availability may change.

Get Agents

get
/ai-agents/v1/agents

Retrieve a list of all agents

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
teamIdnumberRequired
Responses
chevron-right
200

List of agents retrieved successfully

application/json
idstring · uuidRequired
namestringRequired
teamIdintegerRequired
createdAtstring · date-timeRequired
systemPromptstringRequired
defaultModelstringRequired
outputParserone ofOptional
or
get
/ai-agents/v1/agents
200

List of agents retrieved successfully

Create Agent

post
/ai-agents/v1/agents

Create a new agent

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
teamIdnumberRequired
Body

Request body for creating a new agent.

namestringRequired
teamIdnumberRequired
makeConnectionIdnumberRequired
defaultModelstringRequired
systemPromptstring · min: 1Required
outputParserFormatone ofOptional
or
Responses
post
/ai-agents/v1/agents
201

Agent created successfully

Get Agent by ID

get
/ai-agents/v1/agents/{agentId}

Retrieve an agent by its ID

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired
Query parameters
teamIdnumberRequired
Responses
chevron-right
200

Agent retrieved successfully

application/json
idstring · uuidRequired
namestringRequired
teamIdintegerRequired
createdAtstring · date-timeRequired
systemPromptstringRequired
defaultModelstringRequired
makeConnectionIdintegerOptional
makeConnectionTypestring · nullableOptional
llmProviderIdintegerOptional
outputParserone ofOptional
or
get
/ai-agents/v1/agents/{agentId}
200

Agent retrieved successfully

Delete Agent by ID

delete
/ai-agents/v1/agents/{agentId}

Delete an agent by its ID

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired
Query parameters
teamIdnumberRequired
Responses
delete
/ai-agents/v1/agents/{agentId}
204

Agent deleted successfully

No content

Modify Agent by ID

patch
/ai-agents/v1/agents/{agentId}

Modify an existing agent by its ID

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired
Query parameters
teamIdnumberRequired
Body

Request body for modifying an existing agent.

namestringOptional
systemPromptstring · min: 1Optional
defaultModelstringOptional
outputParserFormatone ofOptional
or
Responses
patch
/ai-agents/v1/agents/{agentId}
204

Agent modified successfully

No content

Run Agent

post
/ai-agents/v1/agents/{agentId}/run

Run an agent with the provided ID

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired
Query parameters
teamIdnumberRequired
Body

Request body for running an agent.

threadIdstring · min: 1OptionalDefault: a64d23ed-2580-43e4-a898-e97193d7fd5e
callbackUrlstringOptional
Responses
chevron-right
200

Agent run started successfully

application/json

Response body for running an agent.

responsestringRequired
executionTimeMsintegerOptional
threadIdstring · uuidRequired
lastAgentIterationIdstring · uuidOptional
post
/ai-agents/v1/agents/{agentId}/run
200

Agent run started successfully

Run Agent with Server Sent Events (SSE) Streaming

post
/ai-agents/v1/agents/{agentId}/run/stream

Run an agent with the provided ID and stream the response using Server Sent Events (SSE)

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired
Query parameters
teamIdnumberRequired
Body

Request body for running an agent.

threadIdstring · min: 1OptionalDefault: d7fbd183-6b53-4dba-9469-00ec3d047cef
callbackUrlstringOptional
Responses
chevron-right
200

Agent run with streaming started successfully

text/event-stream
any · nullableOptional

Server-Sent Events stream (text/event-stream)

Example: event:step id:4ebb9c59-ab75-41d5-8146-7407ce71f484 data:{"role":"system","content":"do what user says\nCurrent time (ISO): 2025-06-26T01:42:30.080-06:00","id":"445431dd-c20e-4a58-a043-ca9c131d4010","agentIterationId":"a132ced5-4afd-4444-ac9d-330cc99c4986"}
post
/ai-agents/v1/agents/{agentId}/run/stream
200

Agent run with streaming started successfully

Last updated