Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Response

The agent.

object
enum<string>
required
Available options:
agent
id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

name
string | null
required
provider
enum<string>
required

The voice platform.

Available options:
retell
providerAgentId
string
required

The agent's id on that platform.

source
enum<string>
required

"demo" for synthetic data shaped like the platform's.

Available options:
retell,
demo
currentVersion
integer | null
required
setupStatus
enum<string>
required
Available options:
pending,
approved,
rejected
onboardingStep
string
required
readOnly
boolean
required

True only for the shared demo agent, which is readable by everyone and refuses every write with demo_read_only. A demo copied into the workspace (when the shared demo is off) is the workspace's own agent: false, and writes are accepted.

graceDays
integer
required

The agent's grace period in days, 1 to 90, 7 unless the workspace set its own: an open issue counts as resolved once the agent has taken calls for this long without it, and a version is judged on an issue only once it has taken calls for this long.

Example:

7

createdAt
string<date-time>
required
Example:

"2026-10-02T14:03:07.120Z"

updatedAt
string<date-time>
required
Example:

"2026-10-02T14:03:07.120Z"

counts
object
required