Pause Agent - Voice AI Developer Docs

Pause Agent

curl --request POST \
  --url https://api.voice.ai/agent/v1/agent/{agent_id}/pause

{
  "agent": {
    "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
  }
}

POST

agent

{agent_id}

pause

Pause Agent

curl --request POST \
  --url https://api.voice.ai/agent/v1/agent/{agent_id}/pause

{
  "agent": {
    "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
  }
}

Path Parameters

agent_id

string

required

Response

Successful Response

agent

Agent · object

required

Show child attributes

agent.agent_id

string

required

agent.user_id

string

required

agent.name

string

required

agent.config

Config · object

required

Show child attributes

agent.config.prompt

string | null

agent.config.greeting

string | null

agent.config.llm_temperature

number · null · null

default:0.7

agent.config.llm_model

string | null

default:gemini-2.5-flash-lite

agent.config.tts_min_sentence_len

integer · null · null

default:20

agent.config.tts_params

TTSParams · object

Show child attributes

agent.config.tts_params.speaker

default:0

agent.config.tts_params.voice_id

string | null

agent.config.tts_params.temperature

number · null · null

default:1

agent.config.tts_params.response_format

string | null

default:mp3

agent.config.tts_params.stream

boolean · null · null

default:true

agent.config.tts_params.top_p

number · null · null

default:0.8

agent.config.min_silence_duration

number · null · null

default:0.55

agent.config.min_speech_duration

number · null · null

default:0.1

agent.config.user_silence_timeout

number · null · null

default:10

agent.config.max_call_duration_seconds

number · null · null

default:900

agent.config.allow_interruptions

boolean · null · null

default:true

agent.config.allow_interruptions_on_greeting

boolean · null · null

default:false

Whether to allow interruptions during the greeting message

agent.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

agent.config.auto_noise_reduction

boolean · null · null

default:true

Enable automatic noise reduction based on environment

agent.config.allow_agent_to_end_call

boolean · null · null

default:false

Whether agent can end calls via tool or timeout

agent.config.allow_agent_to_skip_turn

boolean · null · null

default:false

Whether agent can skip turns and yield conversation control

agent.config.allow_outbound_calling

boolean · null · null

default:false

Whether agent can make outbound calls to saved contacts

agent.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

agent.config.outbound_contacts.{key}

string

agent.config.min_endpointing_delay

number · null · null

default:0.5

agent.config.max_endpointing_delay

number · null · null

default:3

agent.config.vad_activation_threshold

number · null · null

default:0.6

agent.config.phone_number

string | null

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

agent.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.

agent.config.available_voices

Available Voices · object

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

Show child attributes

agent.config.available_voices.{key}

object

agent.config.category

enum<string> · null · null

default:business

Available options:

business,

playground

agent.config.playground_visibility

enum<string> · null · null

default:unlisted

Available options:

public,

unlisted

agent.config.voice_creator_username

string | null

agent.config.voice_avatar_url

string | null

agent.created_at

string<date-time>

required

agent.updated_at

string<date-time>

required

agent.status

string

default:paused

agent.status_code

integer

default:1

agent.kb_id

integer · null · null

Deploy Agent Disable Agent

API documentation

Path Parameters

Response