Agents

Get an agent

get/v1/agents/{id}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/agents/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Agent id, e.g. agent_7f3a….

Response

Agent

objectstring
agent_idstring
namestring
persona_system_promptstring nullable
greetingstring nullable
greeting_variantsstring[]
voice_idstring nullable
voice_instructstring

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

brain_modelstring
barge_sensitivitystring nullable
ack_modestring nullable
idle_check_in'auto' | 'patient' | 'off'

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

persona_perspective'agent' | 'caller'

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

mode'default' | 'receptionist' | 'sales' | 'collections'

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

rolestring nullable

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

continuityboolean

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

recordings_enabledboolean
consent_linestring nullable
language'en' | 'fr' | 'es' | 'de' | 'hi' | 'zh' | 'it' | 'pt' | 'ja' | 'ko'

Session language for this agent's calls. Renders the effective default (en) when unset. Canonical staged route identifiers remain excluded from the public enum until qualification.

vocabularystring[]

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

keytermsstring[]
goalsstring[]
metadataobject
extraction_schemaobject nullable

Post-call extraction JSON Schema, or null.

extraction_webhook_urlstring nullable

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

created_atinteger

Unix seconds.

Example response

{
  "object": "agent",
  "agent_id": "agent_7f3a0b12",
  "brain_model": "default",
  "mode": "default"
}

Changes

No recorded changes to this operation across all 1 revision of this API.