Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Speech Engine

Create Speech Engine

Create a new Speech Engine resource

post/v1/speech-engine

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring

Name of the speech engine

languagestring

Language for the speech engine

tagsstring[]

Tags for categorization

Example request

{
  "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": [],
    "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
  }
}

Response

Successful Response

speech_engine_idstring required

The speech engine resource ID

namestring required

Human-readable name for the speech engine

languagestring required

ISO language code used by the speech engine (e.g. 'en')

tagsstring[] required

Arbitrary tags for categorization and filtering

Example response

{
  "asr": {
    "keywords": [],
    "provider": "elevenlabs",
    "quality": "high",
    "user_input_audio_format": "pcm_16000"
  },
  "call_limits": {
    "agent_concurrency_limit": -1,
    "bursting_enabled": true,
    "daily_limit": 100000
  },
  "conversation": {
    "client_events": [
      "audio",
      "interruption",
      "agent_response",
      "user_transcript"
    ],
    "max_duration_seconds": 600
  },
  "language": "en",
  "metadata": {
    "created_at_unix_secs": 1714000000,
    "created_from": "api",
    "last_updated_from": "api",
    "updated_at_unix_secs": 1714000000
  },
  "name": "My Speech Engine",
  "overrides": {
    "first_message": false
  },
  "privacy": {
    "apply_to_existing_conversations": false,
    "delete_audio": false,
    "delete_transcript_and_pii": false,
    "record_voice": true,
    "retention_days": -1,
    "zero_retention_mode": false
  },
  "speech_engine": {
    "request_headers": {},
    "ws_url": "wss://example.com/transcript"
  },
  "speech_engine_id": "seng_3701k3ttaq12ewp8b7qv5rfyszkz",
  "tags": [
    "production",
    "v1"
  ],
  "tts": {
    "agent_output_audio_format": "pcm_16000",
    "model_id": "eleven_flash_v2",
    "optimize_streaming_latency": 3,
    "similarity_boost": 0.8,
    "speed": 1,
    "stability": 0.5,
    "voice_id": "cjVigY5qzO86Huf0OWal"
  },
  "turn": {
    "mode": "turn",
    "silence_end_call_timeout": -1,
    "turn_eagerness": "normal",
    "turn_timeout": 7
  },
  "vad": {
    "background_voice_detection": false
  }
}