Skip to main content
GET
Get an agent

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

id
string
required

Agent id, e.g. agent_7f3a….

Response

Agent

object
string
Example:

"agent"

agent_id
string
Example:

"agent_7f3a0b12"

name
string
persona_system_prompt
string | null
greeting
string | null
greeting_variants
string[]
Maximum array length: 15
voice_id
string | null
brain_model
string
Example:

"default"

barge_sensitivity
string
Example:

"normal"

ack_mode
string
Example:

"auto"

idle_check_in
enum<string>

Idle check-in patience. Renders the effective default (auto) when unset.

Available options:
auto,
patient,
off
persona_perspective
enum<string>

Which side of the call the persona is on. Renders the effective default (agent) when unset.

Available options:
agent,
caller
mode
string
read-only

Read-only runtime mode derived from the agent's role (default, sales, or collections). Set indirectly by choosing a role in the console; not writable through this API.

Example:

"default"

role
string | null
read-only

Read-only archetype the agent was created from, or null. Set in the console; not writable through this API.

recordings_enabled
boolean
language
enum<string>

Session language for this agent's calls. Renders the effective default (en) when unset.

Available options:
en,
fr,
es,
de,
hi
keyterms
string[]
goals
string[]
metadata
object
extraction_schema
object | null

Post-call extraction JSON Schema, or null.

extraction_webhook_url
string | null

Signed delivery target for post-call extraction, or null.

tools
object[]
created_at
integer

Unix seconds.