Skip to main content
GET
/
v1
/
agents
/
{id}
Get an agent
curl --request GET \
  --url https://api.pyai.com/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "agent",
  "agent_id": "agent_7f3a0b12",
  "name": "<string>",
  "persona_system_prompt": "<string>",
  "greeting": "<string>",
  "voice_id": "<string>",
  "brain_model": "default",
  "barge_sensitivity": "normal",
  "ack_mode": "auto",
  "recordings_enabled": true,
  "consent_line": "<string>",
  "keyterms": [
    "<string>"
  ],
  "goals": [
    "<string>"
  ],
  "metadata": {},
  "created_at": 123
}

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
voice_id
string | null
brain_model
string
Example:

"default"

barge_sensitivity
string
Example:

"normal"

ack_mode
string
Example:

"auto"

recordings_enabled
boolean
keyterms
string[]
goals
string[]
metadata
object
created_at
integer

Unix seconds.