Créer un Speech Engine

POST

/v1/speech-engine

POST

/v1/speech-engine

curl -X POST https://api.elevenlabs.io/v1/speech-engine \
     -H "Content-Type: application/json" \
     -d '{
  "speech_engine": {
    "ws_url": "string"
  }
}'

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

Crée une ressource Speech Engine

Requête

This endpoint expects an object.

speech_engineobjectRequis

Configuration WebSocket du Speech Engine

namestringOptionnelPar défaut Speech Engine

Nom du Speech Engine

asrobjectOptionnel

Configuration ASR

ttsobjectOptionnel

Configuration TTS

turnobjectOptionnel

Configuration de la détection des tours de parole

vadobjectOptionnel

Configuration de la détection d’activité vocale

conversationobjectOptionnel

Configuration de conversation (événements client, etc.)

privacyobjectOptionnel

Paramètres de confidentialité (enregistrement, conservation, mode zéro rétention)

call_limitsobjectOptionnel

Limites de requêtes simultanées et de conversations quotidiennes pour ce Speech Engine

languagestringOptionnelPar défaut en

Langue du moteur de synthèse vocale

cascade_timeout_secondsdoubleOptionnel2-15Par défaut 4

Délai, en secondes, d’attente de la réponse du point de terminaison du moteur de synthèse vocale en amont avant l’abandon et la nouvelle tentative. Doit être compris entre 2 et 15 secondes.

tagslist of stringsOptionnel

Étiquettes de catégorisation

overridesobjectOptionnel

Paramètres de remplacement que le client peut définir lors de l’initialisation de la conversation

Réponse

Réponse réussie

speech_engine_idstring

L'ID de ressource du moteur vocal

namestring

Nom lisible du Speech Engine

speech_engineobject

Paramètres de connexion WebSocket pour le serveur de transcription en amont

asrobject

Configuration de la reconnaissance automatique de la parole

ttsobject

Configuration de sortie du Text to Speech

turnobject

Configuration de la détection des tours de parole

vadobject

Configuration de la détection d’activité vocale

conversationobject

Paramètres au niveau de la conversation, y compris les événements client et les limites de durée

privacyobject

Paramètres de confidentialité contrôlant l’enregistrement, la conservation et le traitement des PII

call_limitsobject

Limites de requêtes simultanées et de conversations quotidiennes pour ce Speech Engine

languagestring

Code de langue ISO utilisé par le moteur de synthèse vocale, par exemple « en »

cascade_timeout_secondsdouble

Délai, en secondes, d’attente de la réponse du point de terminaison du moteur de synthèse vocale en amont avant l’abandon et la nouvelle tentative. Doit être compris entre 2 et 15 secondes.

tagslist of strings

Balises arbitraires pour la catégorisation et le filtrage

overridesobject

Paramètres de remplacement que le client peut définir lors de l’initialisation de la conversation

metadataobject

Horodatages de création et de mise à jour avec informations sur la source

access_infoobject or nullOptionnel

Informations d’accès du Speech Engine pour l’utilisateur

Erreurs

422

Unprocessable Entity Error

En-têtes

Requête

Réponse

Erreurs