Skip to main content
GET
/
v1
/
agents
List agent profiles
curl --request GET \
  --url https://api.pyai.com/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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
    }
  ],
  "has_more": false
}

Authorizations

Authorization
string
header
required

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

Response

Agents

object
string
Example:

"list"

data
object[]
has_more
boolean
Example:

false