GET
/
agents
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The id of the agent.

Response

200 - application/json
uri
string
required

The uri of the agent.

account_id
string
required

The id of the owner of the agent.

created_at
string
required

The date and time the agent was created.

updated_at
string
required

The date and time the agent was last updated.

id
string
required

The id of the agent.

initial_message
string

The initial message that the agent will say. If null, the agent will wait for the user to speak first.

prompt
string

The prompt of the agent.

voice
object
language_model
object
transcriber
object
max_duration_seconds
integer
default: 600

The maximum conversation duration in seconds. If null, the conversation can be of any duration. The default value is 10 min.

webhooks
object[]

The webhooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.

hooks
object[]

The hooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.

metadata
object

The metadata of the agent. This is used to store additional information about the agent.

Create Agent