Criar mecanismo de fala

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"
  }
}

Crie um novo recurso do Speech Engine.

Solicitação

This endpoint expects an object.

speech_engineobjectObrigatório

Configuração do WebSocket do mecanismo de fala

namestringOpcionalPadrão é Speech Engine

Nome do mecanismo de fala

asrobjectOpcional

Configuração de ASR

ttsobjectOpcional

Configuração de TTS

turnobjectOpcional

Configuração de detecção de turno

vadobjectOpcional

Configuração para detecção de atividade de voz

conversationobjectOpcional

Configuração da conversa (eventos do cliente etc.)

privacyobjectOpcional

Configurações de privacidade (gravação, retenção, modo de retenção zero)

call_limitsobjectOpcional

Limites de simultaneidade e de conversas diárias para este mecanismo de fala

languagestringOpcionalPadrão é en

Idioma do mecanismo de fala

cascade_timeout_secondsdoubleOpcional2-15Padrão é 4

Tempo em segundos de espera pela resposta do endpoint do mecanismo de voz upstream antes de abandonar e tentar novamente. Deve estar entre 2 e 15 segundos.

tagslist of stringsOpcional

Tags para categorização

overridesobjectOpcional

Configurações de substituição que o cliente pode definir durante o início da conversa

Resposta

Resposta bem-sucedida

speech_engine_idstring

O ID do recurso do mecanismo de fala

namestring

Nome legível para humanos do mecanismo de fala

speech_engineobject

Configurações de conexão WebSocket para o servidor de transcrição upstream

asrobject

Configuração de reconhecimento automático de fala

ttsobject

Configuração de saída de Text to Speech

turnobject

Configuração de detecção de turno

vadobject

Configuração para detecção de atividade de voz

conversationobject

Configurações de nível de conversa, incluindo eventos do cliente e limites de duração

privacyobject

Configurações de privacidade que controlam a gravação, a retenção e o tratamento de PII

call_limitsobject

Limites de simultaneidade e de conversas diárias para este mecanismo de fala

languagestring

Código de idioma ISO usado pelo mecanismo de fala (por exemplo, ‘en’)

cascade_timeout_secondsdouble

Tempo em segundos de espera pela resposta do endpoint do mecanismo de voz upstream antes de abandonar e tentar novamente. Deve estar entre 2 e 15 segundos.

tagslist of strings

Tags arbitrárias para categorização e filtragem

overridesobject

Configurações de substituição que o cliente pode definir durante o início da conversa

metadataobject

Timestamps de criação e atualização com informações da origem

access_infoobject or nullOpcional

As informações de acesso do mecanismo de fala para o usuário

Erros

422

Unprocessable Entity Error

Cabeçalhos

Solicitação

Resposta

Erros