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
voice_instruct
string

Effective TTS delivery direction for instruct-capable voice tiers. Renders PyAI's natural conversational pace when no override is stored.

brain_model
string
Example:

"default"

barge_sensitivity
string | null
deprecated
ack_mode
string | null
deprecated
idle_check_in
enum<string>

Idle check-in patience. Renders auto when unset, except support agents render patient.

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
enum<string>
read-only

Read-only runtime mode derived from the agent's role (default, receptionist, sales, or collections). Set indirectly via the writable role field.

Available options:
default,
receptionist,
sales,
collections
Example:

"default"

role
string | null

Role archetype the agent runs as, or null. Writable on create and update.

continuity
boolean

Whether this agent reuses a prior-call caller card when a caller key is available. Default false.

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
vocabulary
string[]

Sanitized Agent vocabulary. An empty list means speech-recognition biasing is off.

Maximum array length: 5
Required string length: 4 - 64
keyterms
string[]
deprecated
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.