List every agent on your account

GEThttps://server.heyrik.com/api/v1/agents

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataarray

Explore 1 example item

[0]object

Explore 9 properties

idstring

Example "agc_9f2a1c30"

namestring

Example "Support Agent"

languagestring

Example "en-IN"

greetingstring

Example "Hi, thanks for calling Acme — how can I help?"

system_promptstring

Example "You are a friendly support agent…"

voice_settingsobject

Explore 2 properties

voice_idstring

Example "vx_9f2a1c30"

speednumber

Example 1

configobject

Explore 2 properties

modestring

Example "prompt"

languagesarray

Explore 2 example items

[0]string

Example "en-IN"

[1]string

Example "hi-IN"

owner_idstring

Example "usr_2c30d0ac"

created_atstring

Example "2026-07-20T09:14:02.881Z"

Error reference

GET/agents

cURL

curl https://server.heyrik.com/api/v1/agents \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": [
    {
      "id": "agc_9f2a1c30",
      "name": "Support Agent",
      "language": "en-IN",
      "greeting": "Hi, thanks for calling Acme — how can I help?",
      "system_prompt": "You are a friendly support agent…",
      "voice_settings": { "voice_id": "vx_9f2a1c30", "speed": 1.0 },
      "config": { "mode": "prompt", "languages": ["en-IN", "hi-IN"] },
      "owner_id": "usr_2c30d0ac",
      "created_at": "2026-07-20T09:14:02.881Z"
    }
  ]
}

Illustrative examples · No live request is sent