Skip to main content
GET
Get Agent Details
Read only
Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.
Fetch one agent by its id. The request is scoped to the authenticated organization automatically. The response includes the agent’s versions, so this is the endpoint to call when you need the full configuration rather than a list summary.

When to use this

  • Before an update: fetch the current configuration and version numbers, then send only the changed fields to Update Agent.
  • Config review: confirm which version is published and what prompt, voice, and LLM it uses before routing production calls to it.
  • Syncing: mirror agent configuration into your own admin UI or configuration store.
If the agent does not exist or belongs to another organization, the API returns 404 Not Found. See Errors for the standard error format.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Agent ID

Example:

"agent_2g7Xy3tY53gRlp"

Response

Agent returned with all versions and embedded agent_functions.

id
string
required

Signed agent ID

Example:

"agent_2g7Xy3tY53gRlp"

agent_type
enum<string>
required
Available options:
Single_Prompt_Agent,
Conversational_Flow_Agent
folder_id
string | null
current_version_number
integer | null
timezone
string | null
pipeline_type
enum<string> | null
Available options:
Cascaded,
Speech_To_Speech
webhook_id
string | null
current_version
object | null
versions
object[]
created_at
string<date-time>
updated_at
string<date-time>