Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

id
string
required

Unique agent identifier

Pattern: ^[cC][^\s-]{8,}$

Response

200 - application/json

OK

Full agent resource representation

id
string
required

Unique identifier of the agent

Pattern: ^[cC][^\s-]{8,}$
orgId
string
required

Organization ID that owns this agent

Pattern: ^[cC][^\s-]{8,}$
name
string
required

Human-readable display name

slug
string
required

URL-friendly unique identifier

status
enum<string>
required

Current lifecycle status

Available options:
ACTIVE,
SUSPENDED,
DELETED
apiKeyPrefix
string | null
required

Prefix of the agent's API key for identification, or null if no key is set

keyRotatedAt
string<date-time> | null
required

ISO 8601 timestamp of the last API-key rotation, null if never rotated

metadata
object
required

Arbitrary key-value metadata

voiceId
string | null
required

The agent's chosen voice id, or null for the system default.

emailIdentities
object[]
required

Email identities associated with this agent

phoneIdentities
object[]
required

Phone identities associated with this agent

createdAt
string<date-time>
required

Timestamp when the agent was created

updatedAt
string<date-time>
required

Timestamp when the agent was last updated

readiness
object

Per-capability readiness summary. Optional for backward compatibility — clients without readiness handling continue to work; clients that branch on it get the delayed-verification gap closed.