Agent Details List

curl --request GET \
  --url https://api.voice.ai/agent/v1/agent/

{
  "items": [
    {
      "agent_id": "<string>",
      "user_id": "<string>",
      "name": "<string>",
      "config": {
        "prompt": "<string>",
        "greeting": "<string>",
        "llm_temperature": 0.7,
        "llm_model": "gemini-2.5-flash-lite",
        "tts_min_sentence_len": 20,
        "tts_params": {
          "speaker": 0,
          "voice_id": "<string>",
          "temperature": 1,
          "response_format": "mp3",
          "stream": true,
          "top_p": 0.8
        },
        "min_silence_duration": 0.55,
        "min_speech_duration": 0.1,
        "user_silence_timeout": 10,
        "max_call_duration_seconds": 900,
        "allow_interruptions": true,
        "allow_interruptions_on_greeting": false,
        "min_interruption_words": 1,
        "auto_noise_reduction": true,
        "allow_agent_to_end_call": false,
        "allow_agent_to_skip_turn": false,
        "allow_outbound_calling": false,
        "outbound_contacts": {},
        "min_endpointing_delay": 0.5,
        "max_endpointing_delay": 3,
        "vad_activation_threshold": 0.6,
        "phone_number": "<string>",
        "mcp_servers": [
          {}
        ],
        "available_voices": {},
        "category": "business",
        "playground_visibility": "unlisted",
        "voice_creator_username": "<string>",
        "voice_avatar_url": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "paused",
      "status_code": 1,
      "kb_id": 123
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "limit": 123,
    "has_next": true,
    "has_previous": true
  }
}

GET

agent

Agent Details List

curl --request GET \
  --url https://api.voice.ai/agent/v1/agent/

{
  "items": [
    {
      "agent_id": "<string>",
      "user_id": "<string>",
      "name": "<string>",
      "config": {
        "prompt": "<string>",
        "greeting": "<string>",
        "llm_temperature": 0.7,
        "llm_model": "gemini-2.5-flash-lite",
        "tts_min_sentence_len": 20,
        "tts_params": {
          "speaker": 0,
          "voice_id": "<string>",
          "temperature": 1,
          "response_format": "mp3",
          "stream": true,
          "top_p": 0.8
        },
        "min_silence_duration": 0.55,
        "min_speech_duration": 0.1,
        "user_silence_timeout": 10,
        "max_call_duration_seconds": 900,
        "allow_interruptions": true,
        "allow_interruptions_on_greeting": false,
        "min_interruption_words": 1,
        "auto_noise_reduction": true,
        "allow_agent_to_end_call": false,
        "allow_agent_to_skip_turn": false,
        "allow_outbound_calling": false,
        "outbound_contacts": {},
        "min_endpointing_delay": 0.5,
        "max_endpointing_delay": 3,
        "vad_activation_threshold": 0.6,
        "phone_number": "<string>",
        "mcp_servers": [
          {}
        ],
        "available_voices": {},
        "category": "business",
        "playground_visibility": "unlisted",
        "voice_creator_username": "<string>",
        "voice_avatar_url": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "paused",
      "status_code": 1,
      "kb_id": 123
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "limit": 123,
    "has_next": true,
    "has_previous": true
  }
}

Query Parameters

page

integer | null

Page number (1-based)

Required range: x >= 1

limit

integer | null

Items per page

Required range: 1 <= x <= 100

show_statuses

string[] | null

List of statuses to show. By default shows deployed and paused agents.

Response

Successful Response

PaginatedAgentResponse · object
Agent · object[]

items

Agent · object[]

required

Show child attributes

items.agent_id

string

required

items.user_id

string

required

items.name

string

required

items.config

Config · object

required

Show child attributes

items.config.prompt

string | null

items.config.greeting

string | null

items.config.llm_temperature

number · null · null

default:0.7

items.config.llm_model

string | null

default:gemini-2.5-flash-lite

items.config.tts_min_sentence_len

integer · null · null

default:20

items.config.tts_params

TTSParams · object

Show child attributes

items.config.tts_params.speaker

default:0

items.config.tts_params.voice_id

string | null

items.config.tts_params.temperature

number · null · null

default:1

items.config.tts_params.response_format

string | null

default:mp3

items.config.tts_params.stream

boolean · null · null

default:true

items.config.tts_params.top_p

number · null · null

default:0.8

items.config.min_silence_duration

number · null · null

default:0.55

items.config.min_speech_duration

number · null · null

default:0.1

items.config.user_silence_timeout

number · null · null

default:10

items.config.max_call_duration_seconds

number · null · null

default:900

items.config.allow_interruptions

boolean · null · null

default:true

items.config.allow_interruptions_on_greeting

boolean · null · null

default:false

Whether to allow interruptions during the greeting message

items.config.min_interruption_words

integer · null · null

default:1

Minimum words required for interruption (0=any speech, 1+=word count)

Required range: 0 <= x <= 10

items.config.auto_noise_reduction

boolean · null · null

default:true

Enable automatic noise reduction based on environment

items.config.allow_agent_to_end_call

boolean · null · null

default:false

Whether agent can end calls via tool or timeout

items.config.allow_agent_to_skip_turn

boolean · null · null

default:false

Whether agent can skip turns and yield conversation control

items.config.allow_outbound_calling

boolean · null · null

default:false

Whether agent can make outbound calls to saved contacts

items.config.outbound_contacts

Outbound Contacts · object

Saved contacts for outbound calling (name -> phone number mapping). Required if allow_outbound_calling is true.

Show child attributes

items.config.outbound_contacts.{key}

string

items.config.min_endpointing_delay

number · null · null

default:0.5

items.config.max_endpointing_delay

number · null · null

default:3

items.config.vad_activation_threshold

number · null · null

default:0.6

items.config.phone_number

string | null

Phone number in E.164 format (supports multiple providers). Empty strings will be converted to None.

items.config.mcp_servers

Mcp Servers · object[] · null · null

MCP servers configuration. List of MCP server configs with name, description, authentication and connection settings. Transport type is automatically detected from URL path.

items.config.available_voices

Available Voices · object

Voice switching configuration. Format: {'voice_name': {'speaker_id': str, 'sub_prompt': str, 'description': str}}

Show child attributes

items.config.available_voices.{key}

object

items.config.category

enum<string> · null · null

default:business

Available options:

business,

playground

items.config.playground_visibility

enum<string> · null · null

default:unlisted

Available options:

public,

unlisted

items.config.voice_creator_username

string | null

items.config.voice_avatar_url

string | null

items.created_at

string<date-time>

required

items.updated_at

string<date-time>

required

items.status

string

default:paused

items.status_code

integer

default:1

items.kb_id

integer · null · null

pagination

PaginationMeta · object

required

Show child attributes

pagination.current_page

integer

required

pagination.total_pages

integer

required

pagination.total_items

integer

required

pagination.limit

integer

required

pagination.has_next

boolean

required

pagination.has_previous

boolean

required

Transcript Agent

API documentation

Query Parameters

Response