Agents

get

Retrieves multiple agents.

Query parameters
joinsany ofOptionalDefault: []
or
string · enumOptionalPossible values:
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
referenceIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

searchstring · min: 1Optional

Search term to filter agents by name, internal name, role, or prompt.

squadIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

versionIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all agents for the workspace.

application/json
or
get
/api/v1/agents
post

Creates a new agent.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
codeRuntimebooleanRequired

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

internalNamestring · min: 3 · max: 50 · nullableRequired

The internal name of the agent. For internal use only.

iterationsnumber · min: 2 · max: 100Required

The number of iterations (steps) the agent can execute in a single execution.

llmstring · enumRequired

The LLM model key to use for the agent.

Possible values:
llmProviderIdstring · uuid · nullableRequired

The id of the LLM provider to use for the agent.

namestring · min: 3 · max: 50Required

The name of the agent.

picturestring · nullableRequired

The picture of the agent.

planningbooleanRequired

Whether the agent should plan before each execution.

promptstring · min: 1 · max: 10000Required

The main description of the agent's behavior.

reasoningModestring · enum · nullableRequired

The reasoning mode to use for the agent. If null, reasoning will be disabled.

Possible values:
rolestring · min: 1 · max: 250Required

The role of the agent. Particularly useful to give other agents context of what the agent does.

temperaturenumber · max: 2Required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

timezonestring · enum · nullableRequired

The timezone to use for the agent. If null, no timezone will be used.

Possible values:
Responses
200

The agent was created.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

codeRuntimebooleanRequired

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

internalNamestring · min: 3 · max: 50 · nullableRequired

The internal name of the agent. For internal use only.

iterationsnumber · min: 2 · max: 100Required

The number of iterations (steps) the agent can execute in a single execution.

llmstring · enumRequired

The LLM model key to use for the agent.

Possible values:
llmProviderIdstring · uuid · nullableRequired

The id of the LLM provider to use for the agent.

namestring · min: 3 · max: 50Required

The name of the agent.

picturestring · nullableRequired

The picture of the agent.

planningbooleanRequired

Whether the agent should plan before each execution.

promptstring · min: 1 · max: 10000Required

The main description of the agent's behavior.

reasoningModestring · enum · nullableRequired

The reasoning mode to use for the agent. If null, reasoning will be disabled.

Possible values:
rolestring · min: 1 · max: 250Required

The role of the agent. Particularly useful to give other agents context of what the agent does.

superIdentityIdstring · uuidRequired

The super identity ID associated with the agent.

temperaturenumber · max: 2Required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

timezonestring · enum · nullableRequired

The timezone to use for the agent. If null, no timezone will be used.

Possible values:
toolCountintegerRequired

The number of tools currently associated with the agent.

voiceIdstring · uuid · nullableRequired

The TTS voice to use for audio responses. Null when disabled for the agent.

workspaceIdstring · uuidRequired

The workspace ID that owns the agent.

post
/api/v1/agents
post

Creates a new MCP or attaches an existing one to an agent.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
or
Responses
200

The MCP was created or linked to the agent.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
agentIdstring · uuidRequired

The id of the agent to link the MCP to.

mcpIdstring · uuidRequired

The id of the MCP to link to the agent.

post
/api/v1/agents/{agentId}/mcps
post

Creates a new tool or attaches an existing one to an agent.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
or
Responses
200

The tool was created or linked to the agent.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
agentIdstring · uuidRequired

The id of the agent to link the tool to.

toolIdstring · uuidRequired

The id of the tool to link to the agent.

post
/api/v1/agents/{agentId}/tools
post

Executes an agent with provided messages.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
contextstringOptional
Responses
200

The agent was executed.

application/json
attachmentsUrlsstring[]Required
contentany ofRequired
stringOptional
or
post
/api/v1/agents/{id}/execute
get

Retrieves an agent.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves an agent.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

codeRuntimebooleanRequired

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

internalNamestring · min: 3 · max: 50 · nullableRequired

The internal name of the agent. For internal use only.

iterationsnumber · min: 2 · max: 100Required

The number of iterations (steps) the agent can execute in a single execution.

llmstring · enumRequired

The LLM model key to use for the agent.

Possible values:
llmProviderIdstring · uuid · nullableRequired

The id of the LLM provider to use for the agent.

namestring · min: 3 · max: 50Required

The name of the agent.

picturestring · nullableRequired

The picture of the agent.

planningbooleanRequired

Whether the agent should plan before each execution.

promptstring · min: 1 · max: 10000Required

The main description of the agent's behavior.

reasoningModestring · enum · nullableRequired

The reasoning mode to use for the agent. If null, reasoning will be disabled.

Possible values:
rolestring · min: 1 · max: 250Required

The role of the agent. Particularly useful to give other agents context of what the agent does.

superIdentityIdstring · uuidRequired

The super identity ID associated with the agent.

temperaturenumber · max: 2Required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

timezonestring · enum · nullableRequired

The timezone to use for the agent. If null, no timezone will be used.

Possible values:
toolCountintegerRequired

The number of tools currently associated with the agent.

voiceIdstring · uuid · nullableRequired

The TTS voice to use for audio responses. Null when disabled for the agent.

workspaceIdstring · uuidRequired

The workspace ID that owns the agent.

get
/api/v1/agents/{id}
delete

Removes an agent.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The agent was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/agents/{id}
patch

Updates an agent.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
codeRuntimebooleanOptional

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

internalNamestring · min: 3 · max: 50 · nullableOptional

The internal name of the agent. For internal use only.

iterationsnumber · min: 2 · max: 100Optional

The number of iterations (steps) the agent can execute in a single execution.

llmstring · enumOptional

The LLM model key to use for the agent.

Possible values:
llmProviderIdstring · uuid · nullableOptional

The id of the LLM provider to use for the agent.

namestring · min: 3 · max: 50Optional

The name of the agent.

picturestring · nullableOptional

The picture of the agent.

planningbooleanOptional

Whether the agent should plan before each execution.

promptstring · min: 1 · max: 10000Optional

The main description of the agent's behavior.

reasoningModestring · enum · nullableOptional

The reasoning mode to use for the agent. If null, reasoning will be disabled.

Possible values:
rolestring · min: 1 · max: 250Optional

The role of the agent. Particularly useful to give other agents context of what the agent does.

superIdentityIdstring · uuidOptional

The super identity ID associated with the agent.

temperaturenumber · max: 2Optional

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

timezonestring · enum · nullableOptional

The timezone to use for the agent. If null, no timezone will be used.

Possible values:
toolCountintegerOptional

The number of tools currently associated with the agent.

voiceIdstring · uuid · nullableOptional

The TTS voice for audio responses. Null to disable.

Responses
200

The agent was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

codeRuntimebooleanRequired

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

internalNamestring · min: 3 · max: 50 · nullableRequired

The internal name of the agent. For internal use only.

iterationsnumber · min: 2 · max: 100Required

The number of iterations (steps) the agent can execute in a single execution.

llmstring · enumRequired

The LLM model key to use for the agent.

Possible values:
llmProviderIdstring · uuid · nullableRequired

The id of the LLM provider to use for the agent.

namestring · min: 3 · max: 50Required

The name of the agent.

picturestring · nullableRequired

The picture of the agent.

planningbooleanRequired

Whether the agent should plan before each execution.

promptstring · min: 1 · max: 10000Required

The main description of the agent's behavior.

reasoningModestring · enum · nullableRequired

The reasoning mode to use for the agent. If null, reasoning will be disabled.

Possible values:
rolestring · min: 1 · max: 250Required

The role of the agent. Particularly useful to give other agents context of what the agent does.

superIdentityIdstring · uuidRequired

The super identity ID associated with the agent.

temperaturenumber · max: 2Required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

timezonestring · enum · nullableRequired

The timezone to use for the agent. If null, no timezone will be used.

Possible values:
toolCountintegerRequired

The number of tools currently associated with the agent.

voiceIdstring · uuid · nullableRequired

The TTS voice to use for audio responses. Null when disabled for the agent.

workspaceIdstring · uuidRequired

The workspace ID that owns the agent.

patch
/api/v1/agents/{id}
delete

Detaches an MCP from an agent.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

mcpIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The MCP was removed from the agent.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/agents/{agentId}/mcps/{mcpId}
delete

Detaches a tool from an agent.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

toolIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The tool was removed from the agent.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/agents/{agentId}/tools/{toolId}

Last updated