Skip to main content
GET
Retrieve all Agents

Authorizations

x-api-key
string
header
required

Query Parameters

offset
integer
default:0

The number of agents to skip before starting to return results.

perpage
integer
default:10

The number of agents to return per page.

Search criteria to filter agents by name or ID.

Response

List of agents retrieved successfully

id
string<uuid>

Unique identifier for the agent.

Example:

"b63c2a53-266b-4b43-a71b-7ea8b5e2e916"

agent_name
string

Display name of the agent.

Example:

"Customer Support Agent"

agent_system_prompt
string

Foundational system instruction used by this agent.

Example:

"You are a helpful AI assistant that handles customer service inquiries."

avatars
object[]

List of avatars associated with this agent.

callback_events
string[]

Webhook events that should trigger callbacks.

Example:
callback_url
string

Webhook endpoint URL to send callback events to.

Example:

"https://webhooks.example.com/agent-events"

config
object

Agent-level configuration properties.

knowledge_base
object[] | null

List of knowledge bases attached to this agent.

tool
object[] | null

List of tools attached to this agent.

mcp
object[] | null

List of MCP attached to this agent.

record
boolean

Determines whether voice call recordings should be stored.

Example:

true

created_at
string<date-time>

Timestamp indicating when the agent was created.

Example:

"2025-12-01T10:20:30.000Z"

updated_at
string<date-time>

Last updated timestamp for the agent.

Example:

"2025-12-03T14:50:00.000Z"