List Agents | Speechify API

{
  "next_cursor": "agent_01kxmwcejz05xht5gmej146s7k",
  "has_more": true,
  "agents": [
    {
      "id": "agent_01kxmwcejz05xht5gmej146s6j",
      "name": "Cliff Weitzman Assistant",
      "slug": "cliff-weitzman-assistant",
      "prompt": "You are Cliff Weitzman, CEO of Acme Inc, helping users with their daily tasks.",
      "first_message": "Hello! This is Cliff's assistant. How can I help you today?",
      "language": "en-US",
      "llm": {
        "provider": "openai",
        "model": "gpt-4o",
        "base_url": null,
        "credential_id": null,
        "extra_body": {},
        "temperature": 0.5
      },
      "tts": {
        "voice_id": "voice_en_us_cliff_01",
        "speed": 1.1
      },
      "stt": {
        "override": "whisper-v3"
      },
      "turn_handling": {
        "response_delay_seconds": 1.1,
        "inactivity_timeout_seconds": 30
      },
      "memory": {
        "enabled": true,
        "retention_days": 90
      },
      "navigator": {
        "enabled": true,
        "ivr_cache_enabled": true
      },
      "background_noise": {
        "preset": "office",
        "volume": 0.5
      },
      "is_public": true,
      "allowed_origins": [
        "https://app.acmeinc.com"
      ],
      "amd": {
        "enabled": true,
        "on_voicemail": {
          "action": "hangup",
          "message": "Please leave a message after the beep."
        },
        "on_ivr": {
          "action": "proceed"
        },
        "on_unavailable": {
          "action": "hangup"
        },
        "tuning": {
          "human_speech_threshold_seconds": 0.75,
          "no_speech_threshold_seconds": 2,
          "timeout_seconds": 17.5,
          "classification_prompt": "Detect if the call is answered by a human or machine."
        }
      },
      "save_audio_recording": true,
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "widget_config": {
        "version": 1,
        "style": "pill",
        "theme": "dark",
        "avatar": {
          "type": "orb",
          "image_url": "https://cdn.speechify.com/avatars/cliff-weitzman.png",
          "orb_color_1": "#0055FF",
          "orb_color_2": "#00AAFF"
        },
        "text": {
          "start_call": "Start conversation",
          "end_call": "End conversation",
          "listening": "I'm listening...",
          "thinking": "Let me think...",
          "speaking": "Speaking now..."
        },
        "terms": {
          "enabled": true,
          "content": "By using this agent, you agree to Acme Inc's terms and conditions."
        },
        "transcript": {
          "enabled": true
        }
      },
      "hostname_allowlist": [
        "app.acmeinc.com"
      ],
      "webhook_url": "https://webhooks.acmeinc.com/agent-events",
      "webhook_secret_set": true
    }
  ]
}

List voice agents owned by the caller. Cursor-paginated: omit cursor for the first page; walk pages while has_more is true (default page size 50, max 200).

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Query parameters

cursorstringOptional

Opaque pagination cursor from a previous response.

limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

A list of voice agents.

next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean

True when more rows exist beyond this page.

agentslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl https://api.speechify.ai/v1/agents \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

Authentication

Headers

Query parameters

Response headers

Response

Errors