Agents
List AI agents
GET /v1/agents agents:read
Agents come from your connected AI-agent platforms (synced, read-only); manage them there.
Query
limitintegercursorstringincludeRemoved"true" | "false"Include agents that no longer exist in their provider
Responses
- 200
A page of AI agents
Fields
-
dataAgent[] requiredFields
-
idstring required -
providerstring requiredId of the voice-AI integration provider
-
providerAgentIdstring requiredThe agent's id in the provider
-
namestring required -
enabledboolean requiredOnly enabled, non-removed agents are routable
-
removedboolean requiredThe agent no longer exists in the provider
-
metadataobject required -
syncedAtstring | null required
-
-
nextCursorstring | null required
-
- 400
Invalid request
- 401
Missing or invalid API key
- 404
Not found
- 429
rate_limited, or another limit named byerror.code
Get an AI agent
GET /v1/agents/{id} agents:read
Path
idstring required
Responses
- 200
AI agent
Fields
-
dataAgent requiredA read-only mirror of an agent in one of your connected AI-agent platforms. Manage agents there.
Fields
-
idstring required -
providerstring requiredId of the voice-AI integration provider
-
providerAgentIdstring requiredThe agent's id in the provider
-
namestring required -
enabledboolean requiredOnly enabled, non-removed agents are routable
-
removedboolean requiredThe agent no longer exists in the provider
-
metadataobject required -
syncedAtstring | null required
-
-
- 400
Invalid request
- 401
Missing or invalid API key
- 404
Not found
- 429
rate_limited, or another limit named byerror.code