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.
Retrieve a list of all agents
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.
List of agents retrieved successfully
List of agents retrieved successfully
Create a new agent
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.
Request body for creating a new agent.
Agent created successfully
Agent created successfully
Retrieve an agent by its ID
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.
Agent retrieved successfully
Agent retrieved successfully
Delete an agent by its ID
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.
Agent deleted successfully
Agent deleted successfully
No content
Modify an existing agent by its ID
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.
Request body for modifying an existing agent.
Agent modified successfully
Agent modified successfully
No content
Run an agent with the provided ID
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.
Request body for running an agent.
a64d23ed-2580-43e4-a898-e97193d7fd5eAgent run started successfully
Agent run started successfully
Run an agent with the provided ID and stream the response using Server Sent Events (SSE)
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.
Request body for running an agent.
d7fbd183-6b53-4dba-9469-00ec3d047cefAgent run with streaming started successfully
Server-Sent Events stream (text/event-stream)
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"}Agent run with streaming started successfully
Last updated

