Skip to main content

Request

integer
required
Your organization ID
string
required
Your organization API key
string
Filter by agent status (active, draft, paused)
integer
default:"100"
Maximum number of agents to return
integer
default:"0"
Number of records to skip for pagination

Examples

Response

boolean
Indicates if the request was successful
array
Array of agent objects
integer
Total number of agents

Agent Object

integer
Unique identifier for the agent
string
Name of the agent
string
Description of the agent
string
Status of the agent (active, draft, paused)
integer
ID of the voice used by the agent
string
Primary language code
string
Timestamp when the agent was created
string
Timestamp when the agent was last updated

Success Response (200 OK)

Error Responses

object
Missing required fields
object
Organization not found
object
Server error