POST

Try POST /v1/convai/batch-calling/submit — ElevenLabs API

ElevenLabs playground

Submit A Batch Call Request.

Credentials

ElevenLabs API key · sent as xi-api-key

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.elevenlabs.io; the proxy stores and logs nothing about them.

Body application/json

{
  "call_name": "example-call-name",
  "agent_id": "agent-id",
  "recipients": [
    {
      "id": "example-id",
      "phone_number": "example-phone-number",
      "whatsapp_user_id": "example-whatsapp-user-id",
      "conversation_initiation_client_data": {
        "conversation_config_override": {
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "prompt": {
              "knowledge_base": [],
              "llm": "gemini-2.0-flash-001",
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "tool_ids": []
            }
          },
          "asr": {
            "keywords": [
              "hello",
              "world"
            ]
          },
          "conversation": {
            "max_duration_seconds": 600
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "pronunciation_dictionary_locators": [],
            "similarity_boost": 0.8,
            "speed": 1,
            "stability": 0.5,
            "voice_id": "cjVigY5qzO86Huf0OWal"
          },
          "turn": {
            "soft_timeout_config": {
              "message": "Hhmmmm...yeah."
            }
          }
        },
        "custom_llm_extra_body": {},
        "user_id": "example-user-id",
        "source_info": {
          "source": "unknown",
          "version": "example-version"
        },
        "branch_id": "example-branch-id",
        "environment": "example-environment",
        "starting_workflow_node_id": "example-starting-workflow-node-id",
        "procedure_ids": [
          "example-procedure-ids"
        ],
        "dynamic_variables": {}
      }
    }
  ],
  "scheduled_time_unix": 0,
  "agent_phone_number_id": "agent-phone-number-id",
  "whatsapp_params": {
    "whatsapp_phone_number_id": "example-whatsapp-phone-number-id",
    "whatsapp_call_permission_request_template_name": "example-whatsapp-call-permission-request-template-name",
    "whatsapp_call_permission_request_template_language_code": "example-whatsapp-call-permission-request-template-language-code"
  },
  "timezone": "example-timezone",
  "branch_id": "branch-id",
  "environment": "example-environment",
  "telephony_call_config": {
    "ringing_timeout_secs": 60,
    "twilio_call_recording_enabled": false,
    "twilio_machine_detection": {
      "mode": "enable",
      "actions": [
        {
          "action": "hang_up",
          "answered_by": [
            "[recursive or deeply nested schema]"
          ]
        }
      ]
    }
  },
  "target_concurrency_limit": 0
}

11 body fields

call_name · required · string — Request body field call_name.
agent_id · required · string — Request body field agent_id.
recipients · required · object[] — Request body field recipients.
scheduled_time_unix · optional · integer — Request body field scheduled_time_unix.
agent_phone_number_id · optional · string — Request body field agent_phone_number_id.
whatsapp_params · optional · object — Request body field whatsapp_params.
timezone · optional · string — Request body field timezone.
branch_id · optional · string — Request body field branch_id.
environment · optional · string — Request body field environment.
telephony_call_config · optional · object — Request body field telephony_call_config.
target_concurrency_limit · optional · integer — Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.