PATCH

Try PATCH /v1/speech-engine/{speech_engine_id} — ElevenLabs API

ElevenLabs playground

Update Speech Engine

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.

Path

speech_engine_id · required · string The speech engine ID (accepts seng_ or agent_ prefix)

Body application/json

{
  "name": "example-name",
  "speech_engine": {
    "ws_url": "example-ws-url",
    "request_headers": {}
  },
  "asr": {
    "keywords": [
      "hello",
      "world"
    ],
    "provider": "scribe_realtime",
    "quality": "high",
    "user_input_audio_format": "pcm_16000"
  },
  "tts": {
    "agent_output_audio_format": "pcm_16000",
    "model_id": "eleven_turbo_v2",
    "optimize_streaming_latency": 3,
    "pronunciation_dictionary_locators": [],
    "similarity_boost": 0.8,
    "speed": 1,
    "stability": 0.5,
    "voice_id": "cjVigY5qzO86Huf0OWal"
  },
  "turn": {
    "interruption_ignore_term_languages": [],
    "interruption_ignore_terms": [],
    "merge_with_default_ignore_terms": false,
    "mode": "turn",
    "retranscribe_on_turn_timeout": false,
    "silence_end_call_timeout": -1,
    "speculative_turn": false,
    "spelling_patience": "auto",
    "transcribe_on_disabled_interruptions": false,
    "turn_eagerness": "normal",
    "turn_timeout": 7
  },
  "vad": {
    "background_voice_detection": false
  },
  "conversation": {
    "client_events": [
      "audio",
      "interruption"
    ],
    "max_duration_seconds": 600
  },
  "privacy": {
    "apply_to_existing_conversations": false,
    "delete_audio": false,
    "delete_transcript_and_pii": false,
    "record_voice": true,
    "retention_days": -1,
    "zero_retention_mode": false
  },
  "call_limits": {
    "agent_concurrency_limit": -1,
    "bursting_enabled": true,
    "daily_limit": 100000
  },
  "language": "example-language",
  "cascade_timeout_seconds": 0,
  "tags": [
    "example-tags"
  ],
  "overrides": {
    "first_message": false
  }
}

13 body fields

name · optional · string — Request body field name.
speech_engine · optional · object — Request body field speech_engine.
asr · optional · object — Request body field asr.
tts · optional · object — Request body field tts.
turn · optional · object — Request body field turn.
vad · optional · object — Request body field vad.
conversation · optional · object — Request body field conversation.
privacy · optional · object — Request body field privacy.
call_limits · optional · object — Request body field call_limits.
language · optional · string — Request body field language.
cascade_timeout_seconds · optional · number — Time in seconds to wait for the upstream speech engine endpoint to respond before the attempt is abandoned and retried. Must be between 2 and 15 seconds.
tags · optional · string[] — Request body field tags.
overrides · optional · object — Request body field overrides.