> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Criar mecanismo de fala

POST https://api.elevenlabs.io/v1/speech-engine
Content-Type: application/json

Crie um novo recurso do Speech Engine.

Reference: https://elevenlabs.io/docs/api-reference/speech-engine/create

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Body (application/json)

This endpoint expects a CreateSpeechEngineRequest.

- `speech_engine` (SpeechEngineConfig, required) — Configuração do WebSocket do mecanismo de fala
- `name` (string, optional, default: Speech Engine) — Nome do mecanismo de fala
- `asr` (ASRConversationalConfig, optional) — Configuração de ASR
- `tts` (TTSConversationalConfig-Input, optional) — Configuração de TTS
- `turn` (BaseTurnConfig, optional) — Configuração de detecção de turno
- `vad` (VADConfig, optional) — Configuração para detecção de atividade de voz
- `conversation` (ConversationConfig-Input, optional) — Configuração da conversa (eventos do cliente etc.)
- `privacy` (PrivacyConfig-Input, optional) — Configurações de privacidade (gravação, retenção, modo de retenção zero)
- `call_limits` (AgentCallLimits, optional) — Limites de simultaneidade e de conversas diárias para este mecanismo de fala
- `language` (string, optional, default: en) — Idioma do mecanismo de fala
- `cascade_timeout_seconds` (double, optional, default: 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.
- `tags` (list of string, optional) — Tags para categorização
- `overrides` (SpeechEngineConversationInitiationClientDataConfig, optional) — Configurações de substituição que o cliente pode definir durante o início da conversa

## Response

### 201

Resposta bem-sucedida

- `speech_engine_id` (string, required) — O ID do recurso do mecanismo de fala
- `name` (string, required) — Nome legível para humanos do mecanismo de fala
- `speech_engine` (SpeechEngineConfig, required) — Configurações de conexão WebSocket para o servidor de transcrição upstream
- `asr` (ASRConversationalConfig, required) — Configuração de reconhecimento automático de fala
- `tts` (TTSConversationalConfig-Output, required) — Configuração de saída de Text to Speech
- `turn` (BaseTurnConfig, required) — Configuração de detecção de turno
- `vad` (VADConfig, required) — Configuração para detecção de atividade de voz
- `conversation` (ConversationConfig-Output, required) — Configurações de nível de conversa, incluindo eventos do cliente e limites de duração
- `privacy` (PrivacyConfig-Output, required) — Configurações de privacidade que controlam a gravação, a retenção e o tratamento de PII
- `call_limits` (AgentCallLimits, required) — Limites de simultaneidade e de conversas diárias para este mecanismo de fala
- `language` (string, required) — Código de idioma ISO usado pelo mecanismo de fala (por exemplo, 'en')
- `cascade_timeout_seconds` (double, required) — 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.
- `tags` (list of string, required) — Tags arbitrárias para categorização e filtragem
- `overrides` (SpeechEngineConversationInitiationClientDataConfig, required) — Configurações de substituição que o cliente pode definir durante o início da conversa
- `metadata` (AgentMetadataDBModel, required) — Timestamps de criação e atualização com informações da origem
- `access_info` (ResourceAccessInfo, optional, nullable) — As informações de acesso do mecanismo de fala para o usuário

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### SpeechEngineConfig

- `ws_url` (string, required) — A URL WebSocket do servidor de transcrição
- `request_headers` (map from string to SpeechEngineConfigRequestHeaders, optional) — Cabeçalhos a incluir na solicitação de conexão WebSocket

### ASRConversationalConfig

- `quality` (enum, optional, default: high) — A qualidade da transcrição
  - Allowed values: `high`
- `provider` (enum, optional, default: scribe_realtime) — O provedor do serviço de transcrição
  - Allowed values: `elevenlabs`, `scribe_realtime`, `scribe_v2_turbo`
- `user_input_audio_format` (enum, optional, default: pcm_16000) — O formato do áudio a ser transcrito
  - Allowed values: `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`
- `keywords` (list of string, optional) — Palavras-chave para aumentar a probabilidade de previsão

### TTSConversationalConfig-Input

- `model_id` (enum, optional, default: eleven_v4_turbo) — O modelo a ser usado para TTS
  - Allowed values: `eleven_turbo_v2`, `eleven_turbo_v2_5`, `eleven_flash_v2`, `eleven_flash_v2_5`, `eleven_multilingual_v2`, `eleven_v3_conversational`, `eleven_v4`, `eleven_v4_turbo`
- `voice_id` (string, optional, default: cjVigY5qzO86Huf0OWal) — O ID da voz a usar para TTS
- `supported_voices` (list of SupportedVoice, optional) — Vozes adicionais compatíveis com o agente
- `expressive_mode` (boolean, optional, default: true) — Quando ativado, aplica o prompt de tags de áudio expressivas. É desativado automaticamente para modelos que não são v3.
- `suggested_audio_tags` (list of SuggestedAudioTag, optional) — Tags de áudio sugeridas para melhorar a expressividade da fala (para os modelos eleven_v3 e eleven_v3_conversational). O agente ainda pode usar outras tags não listadas aqui.
- `agent_output_audio_format` (enum, optional, default: pcm_16000) — O formato de áudio a ser usado para TTS
  - Allowed values: `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`
- `stability` (double, optional, default: 0.5) — A estabilidade da fala gerada
- `speed` (double, optional, default: 1) — A velocidade da fala gerada
- `similarity_boost` (double, optional, default: 0.8) — O aumento de similaridade para a fala gerada
- `text_normalisation_type` (enum, optional, default: system_prompt) — Método para converter números em palavras antes de converter texto em voz. Se definido como SYSTEM_PROMPT, o prompt do sistema será atualizado para incluir instruções de normalização. Se definido como ELEVENLABS, o texto será normalizado após a geração, gerando uma pequena latência adicional.
  - Allowed values: `system_prompt`, `elevenlabs`
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional) — Os localizadores do dicionário de pronúncia
- `enable_phoneme_tags` (boolean, optional, default: true) — Ative o processamento de tags de fonemas SSML para modelos V3. Quando ativadas, as tags de fonemas (em linha e de dicionários de pronúncia) são analisadas em IPA em linha antes de serem enviadas ao modelo.
- `audio_effects` (EffectsSpec-Input, optional, nullable) — Especificação opcional de efeitos de TTS: predefinição de filtro, distância (EQ de proximidade) e ambiente (reverberação por convolução).
- `optimize_streaming_latency` (enum, optional, deprecated) — Descontinuado: este campo não tem efeito e é ignorado.
  - Allowed values: `0`, `1`, `2`, `3`, `4`

### BaseTurnConfig

- `turn_timeout` (double, optional, default: 7) — Tempo máximo de espera pela resposta do usuário antes de retomar o contato
- `initial_wait_time` (double, optional, nullable) — Por quanto tempo o agente aguardará o usuário iniciar a conversa se a primeira mensagem estiver vazia. Se não for definido, usa o turn_timeout regular.
- `silence_end_call_timeout` (double, optional, default: -1) — Tempo máximo de espera desde a última fala do usuário antes de encerrar a chamada
- `turn_eagerness` (enum, optional, default: normal) — Controla o quanto o agente está disposto a responder. Baixo = menos disposto (espera mais), Padrão = nível padrão, Alto = mais disposto (responde mais cedo)
  - Allowed values: `patient`, `normal`, `eager`
- `spelling_patience` (enum, optional, default: auto) — Controla se o agente deve ser mais paciente quando o usuário estiver soletrando números e entidades nomeadas. Auto = baseado no modelo, Off = nunca aguardar mais tempo.
  - Allowed values: `auto`, `off`
- `speculative_turn` (boolean, optional, default: false) — Quando ativado, começa a gerar respostas do LLM durante o silêncio antes que a confiança total do turno seja alcançada, reduzindo a latência percebida. Pode aumentar os custos do LLM.
- `retranscribe_on_turn_timeout` (boolean, optional, default: false) — Quando ativada, se o VAD não detectar fala, tenta transcrever novamente o áudio acumulado quando o turno atinge o tempo limite. Desativa a cobrança com desconto por silêncio enquanto estiver ativada para o agente ou nó de workflow ativo.
- `turn_model` (enum, optional, default: turn_v3) — Versão do modelo de detecção de turno a ser usada.
  - Allowed values: `turn_v2`, `turn_v3`
- `interruption_ignore_terms` (list of string, optional) — Lista de termos que não devem acionar uma interrupção quando ditos pelo usuário (por exemplo, 'entendi', 'compreendido'). Usa correspondência exata sem diferenciação entre maiúsculas e minúsculas.
- `interruption_ignore_term_languages` (list of string, optional) — Códigos de idioma para os quais categorias predefinidas de termos a ignorar foram ativadas. Armazenados explicitamente para que a exibição não seja inferida pela sobreposição de termos.
- `merge_with_default_ignore_terms` (boolean, optional, default: false) — Quando ativado, os termos padrão selecionados para interruption_ignore_term_languages são usados além de interruption_ignore_terms.
- `transcribe_on_disabled_interruptions` (boolean, optional, default: false) — Quando as interrupções estão desativadas, ainda transcreve o que o usuário diz para que seja levado para o próximo turno. Quando desativado, a fala do usuário durante um turno não interrompível é ignorada e não inicia um turno.

### VADConfig

### ConversationConfig-Input

- `text_only` (boolean, optional, default: false) — Se ativado, o áudio não será processado e apenas o texto será usado. Use para evitar a cobrança de áudio.
- `max_duration_seconds` (integer, optional, default: 600) — A duração máxima de uma conversa em segundos
- `client_events` (list of enum, optional) — Os eventos que serão enviados ao cliente
  - Allowed values: `conversation_initiation_metadata`, `asr_initiation_metadata`, `ping`, `audio`, `interruption`, `user_transcript`, `tentative_user_transcript`, `agent_response`, `agent_response_correction`, `client_tool_call`, `mcp_tool_call`, `mcp_connection_status`, `agent_tool_request`, `agent_tool_response`, `agent_tool_response_full_payload`, `agent_response_metadata`, `vad_score`, `agent_chat_response_part`, `client_error`, `guardrail_triggered`, `dtmf_request`, `agent_response_complete`, `context_usage`, `internal_turn_probability`, `internal_tentative_agent_response`
- `file_input` (FileInputConfig, optional) — Configuração para entrada de arquivos (uploads de imagens/PDFs) durante conversas.
- `monitoring_enabled` (boolean, optional, default: false) — Ative o monitoramento de conversas em tempo real via WebSocket
- `monitoring_events` (list of enum, optional) — Os eventos que serão enviados às conexões de monitoramento.
  - Allowed values: `conversation_initiation_metadata`, `asr_initiation_metadata`, `ping`, `audio`, `interruption`, `user_transcript`, `tentative_user_transcript`, `agent_response`, `agent_response_correction`, `client_tool_call`, `mcp_tool_call`, `mcp_connection_status`, `agent_tool_request`, `agent_tool_response`, `agent_tool_response_full_payload`, `agent_response_metadata`, `vad_score`, `agent_chat_response_part`, `client_error`, `guardrail_triggered`, `dtmf_request`, `agent_response_complete`, `context_usage`, `internal_turn_probability`, `internal_tentative_agent_response`
- `dtmf_input_settings` (DTMFInputConfig, optional, nullable) — Configure a coleta de entrada DTMF (teclado) durante chamadas telefônicas
- `background_sound` (BackgroundSoundConfig, optional) — Configuração do som de fundo durante conversas.
- `source_attribution` (boolean, optional, default: false) — Quando ativado e houver conteúdo na base de conhecimento, o LLM é instruído a informar quais fontes utilizou.

### PrivacyConfig-Input

- `record_voice` (boolean, optional, default: true) — Se deve gravar a conversa
- `retention_days` (integer, optional, default: -1) — O número de dias para reter a conversa. -1 indica que não há limite de retenção
- `delete_transcript_and_pii` (boolean, optional, default: false) — Indica se deve excluir a transcrição e as informações de identificação pessoal (PII)
- `delete_audio` (boolean, optional, default: false) — Indica se deve excluir o áudio
- `apply_to_existing_conversations` (boolean, optional, default: false) — Indica se deve aplicar as configurações de privacidade às conversas existentes
- `zero_retention_mode` (boolean, optional, default: false) — Indica se deve ativar o modo de retenção zero — nenhum dado de PII é armazenado
- `conversation_history_redaction` (ConversationHistoryRedactionConfig, optional) — Configuração para ocultação de PII no histórico da conversa

### AgentCallLimits

- `agent_concurrency_limit` (integer, optional, default: -1) — O número máximo de conversas simultâneas. -1 indica que não há máximo.
- `daily_limit` (integer, optional, default: 100000) — O número máximo de conversas por dia
- `bursting_enabled` (boolean, optional, default: true) — Indica se deve ativar o bursting. Se verdadeiro, será permitido exceder o limite de simultaneidade do espaço de trabalho em até 3 vezes. As chamadas serão cobradas em dobro ao exceder o limite.

### SpeechEngineConversationInitiationClientDataConfig

- `first_message` (boolean, optional, default: false) — Se a primeira mensagem pode ser substituída pelo cliente.

### TTSConversationalConfig-Output

- `model_id` (enum, optional, default: eleven_v4_turbo) — O modelo a ser usado para TTS
  - Allowed values: `eleven_turbo_v2`, `eleven_turbo_v2_5`, `eleven_flash_v2`, `eleven_flash_v2_5`, `eleven_multilingual_v2`, `eleven_v3_conversational`, `eleven_v4`, `eleven_v4_turbo`
- `voice_id` (string, optional, default: cjVigY5qzO86Huf0OWal) — O ID da voz a usar para TTS
- `supported_voices` (list of SupportedVoice, optional) — Vozes adicionais compatíveis com o agente
- `expressive_mode` (boolean, optional, default: true) — Quando ativado, aplica o prompt de tags de áudio expressivas. É desativado automaticamente para modelos que não são v3.
- `suggested_audio_tags` (list of SuggestedAudioTag, optional) — Tags de áudio sugeridas para melhorar a expressividade da fala (para os modelos eleven_v3 e eleven_v3_conversational). O agente ainda pode usar outras tags não listadas aqui.
- `agent_output_audio_format` (enum, optional, default: pcm_16000) — O formato de áudio a ser usado para TTS
  - Allowed values: `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`
- `stability` (double, optional, default: 0.5) — A estabilidade da fala gerada
- `speed` (double, optional, default: 1) — A velocidade da fala gerada
- `similarity_boost` (double, optional, default: 0.8) — O aumento de similaridade para a fala gerada
- `text_normalisation_type` (enum, optional, default: system_prompt) — Método para converter números em palavras antes de converter texto em voz. Se definido como SYSTEM_PROMPT, o prompt do sistema será atualizado para incluir instruções de normalização. Se definido como ELEVENLABS, o texto será normalizado após a geração, gerando uma pequena latência adicional.
  - Allowed values: `system_prompt`, `elevenlabs`
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional) — Os localizadores do dicionário de pronúncia
- `enable_phoneme_tags` (boolean, optional, default: true) — Ative o processamento de tags de fonemas SSML para modelos V3. Quando ativadas, as tags de fonemas (em linha e de dicionários de pronúncia) são analisadas em IPA em linha antes de serem enviadas ao modelo.
- `audio_effects` (EffectsSpec-Output, optional, nullable) — Especificação opcional de efeitos de TTS: predefinição de filtro, distância (EQ de proximidade) e ambiente (reverberação por convolução).
- `optimize_streaming_latency` (enum, optional, deprecated) — Descontinuado: este campo não tem efeito e é ignorado.
  - Allowed values: `0`, `1`, `2`, `3`, `4`

### ConversationConfig-Output

- `text_only` (boolean, optional, default: false) — Se ativado, o áudio não será processado e apenas o texto será usado. Use para evitar a cobrança de áudio.
- `max_duration_seconds` (integer, optional, default: 600) — A duração máxima de uma conversa em segundos
- `client_events` (list of enum, optional) — Os eventos que serão enviados ao cliente
  - Allowed values: `conversation_initiation_metadata`, `asr_initiation_metadata`, `ping`, `audio`, `interruption`, `user_transcript`, `tentative_user_transcript`, `agent_response`, `agent_response_correction`, `client_tool_call`, `mcp_tool_call`, `mcp_connection_status`, `agent_tool_request`, `agent_tool_response`, `agent_tool_response_full_payload`, `agent_response_metadata`, `vad_score`, `agent_chat_response_part`, `client_error`, `guardrail_triggered`, `dtmf_request`, `agent_response_complete`, `context_usage`, `internal_turn_probability`, `internal_tentative_agent_response`
- `file_input` (FileInputConfig, optional) — Configuração para entrada de arquivos (uploads de imagens/PDFs) durante conversas.
- `monitoring_enabled` (boolean, optional, default: false) — Ative o monitoramento de conversas em tempo real via WebSocket
- `monitoring_events` (list of enum, optional) — Os eventos que serão enviados às conexões de monitoramento.
  - Allowed values: `conversation_initiation_metadata`, `asr_initiation_metadata`, `ping`, `audio`, `interruption`, `user_transcript`, `tentative_user_transcript`, `agent_response`, `agent_response_correction`, `client_tool_call`, `mcp_tool_call`, `mcp_connection_status`, `agent_tool_request`, `agent_tool_response`, `agent_tool_response_full_payload`, `agent_response_metadata`, `vad_score`, `agent_chat_response_part`, `client_error`, `guardrail_triggered`, `dtmf_request`, `agent_response_complete`, `context_usage`, `internal_turn_probability`, `internal_tentative_agent_response`
- `dtmf_input_settings` (DTMFInputConfig, optional, nullable) — Configure a coleta de entrada DTMF (teclado) durante chamadas telefônicas
- `background_sound` (BackgroundSoundConfig, optional) — Configuração do som de fundo durante conversas.
- `source_attribution` (boolean, optional, default: false) — Quando ativado e houver conteúdo na base de conhecimento, o LLM é instruído a informar quais fontes utilizou.

### PrivacyConfig-Output

- `record_voice` (boolean, optional, default: true) — Se deve gravar a conversa
- `retention_days` (integer, optional, default: -1) — O número de dias para reter a conversa. -1 indica que não há limite de retenção
- `delete_transcript_and_pii` (boolean, optional, default: false) — Indica se deve excluir a transcrição e as informações de identificação pessoal (PII)
- `delete_audio` (boolean, optional, default: false) — Indica se deve excluir o áudio
- `apply_to_existing_conversations` (boolean, optional, default: false) — Indica se deve aplicar as configurações de privacidade às conversas existentes
- `zero_retention_mode` (boolean, optional, default: false) — Indica se deve ativar o modo de retenção zero — nenhum dado de PII é armazenado
- `conversation_history_redaction` (ConversationHistoryRedactionConfig, optional) — Configuração para ocultação de PII no histórico da conversa

### AgentMetadataDBModel

- `created_at_unix_secs` (integer, required)
- `updated_at_unix_secs` (integer, required)
- `created_from` (enum, optional, default: unknown)
  - Allowed values: `cli`, `ui`, `api`, `template`, `unknown`
- `last_updated_from` (enum, optional, default: unknown)
  - Allowed values: `cli`, `ui`, `api`, `template`, `unknown`

### ResourceAccessInfo

- `is_creator` (boolean, required) — Indica se o usuário que faz a solicitação é o criador do agente
- `creator_name` (string, required) — Nome do criador do agente
- `creator_email` (string, required) — E-mail do criador do agente
- `role` (enum, required) — A função do usuário que faz a solicitação
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — O nível de acesso para usuários anônimos. Se for None, o recurso não será compartilhado publicamente.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Por que o usuário solicitante tem acesso a este recurso. 'creator' = o chamador é o proprietário. 'explicit' = o chamador (ou um dos grupos do workspace dele) está listado em role_to_group_ids além do grupo everyone de todo o workspace. 'workspace_default' = o grupo everyone de todo o workspace está listado em role_to_group_ids (todos os membros não anônimos do workspace, incluindo administradores, veem este recurso). 'workspace_admin' = o chamador é administrador do workspace e a função de administrador é o *único* caminho de acesso; reservado para documentos que ninguém mais pode ver. Permite que a interface revele por que um visualizador com desvio de administrador vê um documento que não foi compartilhado explicitamente com ele.
  - Allowed values: `creator`, `explicit`, `workspace_admin`, `workspace_default`

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### SpeechEngineConfigRequestHeaders

### SupportedVoice

- `label` (string, required)
- `voice_id` (string, required)
- `description` (string, optional, nullable)
- `language` (string, optional, nullable)
- `model_family` (enum, optional, nullable)
  - Allowed values: `turbo`, `flash`, `multilingual`, `v3_conversational`, `v4`, `v4_turbo`
- `optimize_streaming_latency` (enum, optional, nullable)
  - Allowed values: `0`, `1`, `2`, `3`, `4`
- `stability` (double, optional, nullable)
- `speed` (double, optional, nullable)
- `similarity_boost` (double, optional, nullable)

### SuggestedAudioTag

- `tag` (string, required) — Tag de áudio a usar (para melhor desempenho, 1 a 2 palavras, por exemplo, 'feliz', 'animado')
- `description` (string, optional, nullable) — Descrição opcional de quando usar esta tag

### PydanticPronunciationDictionaryVersionLocator

Um localizador para que outros documentos possam fazer referência a um dicionário específico e à sua versão. Esta é uma versão pydantic de PronunciationDictionaryVersionLocatorDBModel. Necessário para garantir compatibilidade com os demais modelos de dados do agente.

- `pronunciation_dictionary_id` (string, required) — O ID do dicionário de pronúncia
- `version_id` (string, required, nullable) — O ID da versão do dicionário de pronúncia

### EffectsSpec-Input

Efeitos de áudio aplicados à fala gerada: uma predefinição de filtro, distância percebida, um ambiente de reverberação, uma camada de ruído de fundo e panoramização estéreo. Deixe todos os campos com os valores padrão para obter áudio sem processamento.

- `filter_preset_id` (string, optional, nullable) — ID de uma predefinição de filtro que modifica o timbre da voz, como `phone` ou `old_radio`. Liste IDs válidos com `GET /v1/audio-effects/catalog`.
- `distance` (double, optional, default: 0) — A distância em que o falante parece estar do microfone, de 0 (próximo, sem alteração) a 1 (distante). Valores mais altos atenuam as frequências graves e agudas e, quando um ambiente é definido, deslocam o equilíbrio da voz seca para a reverberação.
- `environment_id` (string, optional, nullable) — ID de um ambiente de reverberação que insere a voz em um espaço, como `small_room` ou `hall`. Liste IDs válidos com `GET /v1/audio-effects/catalog`. A reverberação é renderizada em estéreo e adiciona uma cauda de até vários segundos após o fim da fala.
- `background_noise_id` (string, optional, nullable) — ID de uma camada de ruído de fundo reproduzida em loop sob a voz, como `cafe` ou `keyboard`. Liste IDs válidos com `GET /v1/audio-effects/catalog`.
- `send_level` (double, optional, default: 1) — Quanto da voz é enviado para a reverberação, de 0 (nada) a 1 (total). Só se aplica quando `environment_id` está definido; 0 desativa a reverberação.
- `pan` (double, optional, default: 0) — Posição estéreo da voz, de -1 (totalmente à esquerda), passando por 0 (centro), até 1 (totalmente à direita). Apenas a voz é panoramizada; a reverberação e o ruído de fundo permanecem centralizados.

### FileInputConfig

- `enabled` (boolean, optional, default: true) — Quando ativado, os usuários podem anexar imagens, PDFs ou arquivos de texto no chat quando o LLM oferece suporte a entrada multimodal.
- `max_files_in_memory` (integer, optional, default: 10) — Número dos arquivos mais recentes mantidos na memória durante uma conversa. Os arquivos mais antigos são resumidos e seus bytes são liberados.
- `max_files_per_conversation` (integer, optional, default: 10) — Total de arquivos que um usuário pode enviar em uma conversa. Os envios são cobrados por arquivo. Use -1 para não definir limite ou um valor >= max_files_in_memory.

### DTMFInputConfig

Configuração da coleta de entrada DTMF (teclado) durante chamadas telefônicas.

- `dtmf_input_timeout` (double, optional, default: 2) — Tempo limite, em segundos, para aguardar dígitos DTMF adicionais
- `hash_terminator` (boolean, optional, default: true) — Se for true, pressionar # conclui imediatamente a entrada DTMF.
- `redact_input` (boolean, optional, default: false) — Se for true, substitui as entradas DTMF (teclado) do chamador por um marcador de redação na transcrição, no registro da conversa e na análise. Os dígitos que o agente repete ou passa para uma ferramenta não são afetados.

### BackgroundSoundConfig

- `source_type` (enum, optional, nullable) — O tipo de fonte de som de fundo.
  - Allowed values: `preset`
- `source_id` (enum, optional, nullable) — Identificador da fonte sonora.
  - Allowed values: `office2`, `office1`, `restaurant`, `city`, `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4`
- `volume` (double, optional, default: 0.15) — Nível de volume do som de fundo (0,01 a 1,0).
- `crossfade_loop` (boolean, optional, default: true) — Aplique um crossfade no limite do loop para evitar estalos audíveis quando o som se repetir.

### ConversationHistoryRedactionConfig

- `enabled` (boolean, optional, default: false) — Se a ocultação de dados do histórico da conversa está ativada.
- `entities` (list of enum, optional) — As entidades a serem ocultadas da transcrição, do áudio e da análise da conversa. Use tipos de nível superior como 'name', 'email_address' ou notação com ponto para subtipos específicos, como 'name.full_name'.
  - Allowed values: `name`, `name.name_given`, `name.name_family`, `name.name_other`, `email_address`, `contact_number`, `dob`, `age`, `religious_belief`, `political_opinion`, `sexual_orientation`, `ethnicity_race`, `marital_status`, `occupation`, `physical_attribute`, `language`, `username`, `password`, `url`, `organization`, `financial_id`, `financial_id.payment_card`, `financial_id.payment_card.payment_card_number`, `financial_id.payment_card.payment_card_expiration_date`, `financial_id.payment_card.payment_card_cvv`, `financial_id.bank_account`, `financial_id.bank_account.bank_account_number`, `financial_id.bank_account.bank_routing_number`, `financial_id.bank_account.swift_bic_code`, `financial_id.financial_id_other`, `location`, `location.location_address`, `location.location_city`, `location.location_postal_code`, `location.location_coordinate`, `location.location_state`, `location.location_country`, `location.location_other`, `date`, `date_interval`, `unique_id`, `unique_id.government_issued_id`, `unique_id.account_number`, `unique_id.vehicle_id`, `unique_id.healthcare_number`, `unique_id.healthcare_number.medical_record_number`, `unique_id.healthcare_number.health_plan_beneficiary_number`, `unique_id.device_id`, `unique_id.unique_id_other`, `medical`, `medical.medical_condition`, `medical.medication`, `medical.medical_procedure`, `medical.medical_measurement`, `medical.medical_other`
- `excluded_data_collection_ids` (list of string, optional) — IDs dos itens de coleta de dados cujos valores extraídos não foram ocultados. As justificativas ainda são ocultadas.

### EffectsSpec-Output

Efeitos de áudio aplicados à fala gerada: uma predefinição de filtro, distância percebida, um ambiente de reverberação, uma camada de ruído de fundo e panoramização estéreo. Deixe todos os campos com os valores padrão para obter áudio sem processamento.

- `filter_preset_id` (string, required, nullable) — ID de uma predefinição de filtro que modifica o timbre da voz, como `phone` ou `old_radio`. Liste IDs válidos com `GET /v1/audio-effects/catalog`.
- `distance` (double, required, default: 0) — A distância em que o falante parece estar do microfone, de 0 (próximo, sem alteração) a 1 (distante). Valores mais altos atenuam as frequências graves e agudas e, quando um ambiente é definido, deslocam o equilíbrio da voz seca para a reverberação.
- `environment_id` (string, required, nullable) — ID de um ambiente de reverberação que insere a voz em um espaço, como `small_room` ou `hall`. Liste IDs válidos com `GET /v1/audio-effects/catalog`. A reverberação é renderizada em estéreo e adiciona uma cauda de até vários segundos após o fim da fala.
- `background_noise_id` (string, required, nullable) — ID de uma camada de ruído de fundo reproduzida em loop sob a voz, como `cafe` ou `keyboard`. Liste IDs válidos com `GET /v1/audio-effects/catalog`.
- `send_level` (double, required, default: 1) — Quanto da voz é enviado para a reverberação, de 0 (nada) a 1 (total). Só se aplica quando `environment_id` está definido; 0 desativa a reverberação.
- `pan` (double, required, default: 0) — Posição estéreo da voz, de -1 (totalmente à esquerda), passando por 0 (centro), até 1 (totalmente à direita). Apenas a voz é panoramizada; a reverberação e o ruído de fundo permanecem centralizados.

### ValidationErrorLocItems

### ConvAISecretLocator

Usado para referenciar um segredo do armazenamento de segredos do agente.

- `secret_id` (string, required)

### ConvAIDynamicVariable

Usado para referenciar uma variável dinâmica.

- `variable_name` (string, required)

## Examples

**Request**

```json
{
  "speech_engine": {
    "ws_url": "string"
  }
}
```

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/speech-engine"

payload = { "speech_engine": { "ws_url": "string" } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/speech-engine';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"speech_engine":{"ws_url":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/speech-engine"

	payload := strings.NewReader("{\n  \"speech_engine\": {\n    \"ws_url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/speech-engine")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"speech_engine\": {\n    \"ws_url\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.elevenlabs.io/v1/speech-engine")
  .header("Content-Type", "application/json")
  .body("{\n  \"speech_engine\": {\n    \"ws_url\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/speech-engine', [
  'body' => '{
  "speech_engine": {
    "ws_url": "string"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/speech-engine");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"speech_engine\": {\n    \"ws_url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["speech_engine": ["ws_url": "string"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/speech-engine")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```