> 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. # Executar testes no agente POST https://api.elevenlabs.io/v1/convai/agents/{agent_id}/run-tests Content-Type: application/json Execute os testes selecionados no agente com a configuração fornecida. Se a configuração do agente for fornecida, ela será usada para substituir a configuração padrão do agente. Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/tests/run-tests ## 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 ### Path parameters - `agent_id` (string, required) — O ID de um agente. Ele é retornado na criação do agente. ### Body (application/json) This endpoint expects an object. - `tests` (list of SingleTestRunRequestModel, required) — Lista de testes a executar no agente - `agent_config_override` (AdhocAgentConfigOverrideForTestRequestModel, optional) — Substituições de configuração a usar nos testes. Se não forem fornecidas, será usada a configuração padrão do agente. - `branch_id` (string, optional) — ID da ramificação em que os testes serão executados. Se não for fornecido, os testes serão executados na ramificação principal do agente. - `repeat_count` (integer, optional, default: 1) — Número de vezes para executar cada teste. Quando maior que 1, os resultados são agrupados e resumidos. ## Response ### 200 Resposta bem-sucedida - `id` (string, required) - `test_runs` (list of UnitTestRunResponseModel, required) - `agent_id` (string, optional) - `branch_id` (string, optional) - `version_id` (string, optional) - `ran_against_draft` (boolean, optional, default: false) - `created_at` (integer, optional) - `folder_id` (string, optional) - `repeat_count` (integer, optional, default: 1) - `cancelled` (boolean, optional, default: false) - `bucketing_status` (enum, optional) — None quando repeat_count==1 (sem agrupamento). Caso contrário, acompanha o ciclo de vida do agrupamento. - Allowed values: `pending`, `completed`, `failed` - `result_groups` (list of TestRunResultSummary, optional) ## Errors ### 422 Agents Run Tests Request Unprocessable Entity Error Erro de validação - `detail` (list of ValidationError, optional) ## Types ### SingleTestRunRequestModel - `test_id` (string, required) — ID do teste a executar - `workflow_node_id` (string, optional) — ID do nó do workflow em que o teste será executado. Se não for fornecido, o teste será executado no nó de workflow padrão do agente. - `root_folder_id` (string, optional) — ID da pasta raiz em que o teste será executado. Se não for fornecido, o teste será executado na pasta padrão do agente. - `root_folder_name` (string, optional) — Nome da pasta raiz em que o teste será executado. Se não for fornecido, o teste será executado na pasta padrão do agente. ### AdhocAgentConfigOverrideForTestRequestModel - `conversation_config` (ConversationalConfig, required) - `platform_settings` (AgentPlatformSettingsRequestModel, required) - `workflow` (AgentWorkflowRequestModel, optional) ### UnitTestRunResponseModel - `test_run_id` (string, required) - `test_invocation_id` (string, required) - `agent_id` (string, required) - `status` (enum, required) - Allowed values: `pending`, `passed`, `failed`, `cancelled` - `test_id` (string, required) - `test_info` (UnitTestRunResponseModelTestInfo, optional) - `branch_id` (string, optional) - `version_id` (string, optional) - `ran_against_draft` (boolean, optional, default: false) - `workflow_node_id` (string, optional) - `agent_responses` (list of ConversationHistoryTranscriptCommonModelOutput, optional) - `test_name` (string, optional, default: Unknown Test) - `condition_result` (TestConditionResultCommonModel, optional) - `last_updated_at_unix` (integer, optional) - `metadata` (TestRunMetadata, optional) - `root_folder_id` (string, optional) - `root_folder_name` (string, optional) - `environment` (string, optional) - `credits_used` (integer, optional) — Créditos cobrados por esta execução de teste. None para execuções criadas antes do rastreamento de custos. - `charging` (ConversationChargingCommonModel, optional) — Detalhamento final da cobrança e do uso do provedor para esta execução de teste. ### TestRunResultSummary - `test_id` (string, required) - `test_name` (string, required) - `buckets` (list of TestRunResultBucket, required) - `workflow_node_id` (string, optional) ### ValidationError - `loc` (list of ValidationErrorLocItem, required) - `msg` (string, required) - `type` (string, required) ### ConversationalConfig - `asr` (AsrConversationalConfig, optional) — Configuração para transcrição conversacional - `turn` (TurnConfig, optional) — Configuração para detecção de turnos - `tts` (TtsConversationalConfigOutput, optional) — Configuração para Text to Speech conversacional - `conversation` (ConversationConfigOutput, optional) — Configuração para eventos de conversa - `language_presets` (map from string to LanguagePresetOutput, optional) — Predefinições de idioma para conversas - `vad` (VadConfig, optional) — Configuração para detecção de atividade de voz - `agent` (AgentConfig, optional) — Configuração específica do agente ### AgentPlatformSettingsRequestModel - `evaluation` (EvaluationSettingsInput, optional) — Configurações de avaliação - `widget` (WidgetConfig, optional) — Configuração do widget - `data_collection` (map from string to AnalysisProperty, optional) — Configurações de coleta de dados - `data_collection_scopes` (map from string to enum, optional) — Escopo por ID de item de coleta de dados. Chaves ausentes usam o escopo da conversa por padrão. - Allowed values: `conversation`, `agent` - `analysis_items` (AgentAnalysisItemsInput, optional) — Itens de avaliação e coleta de dados anexados por referência. None significa que o agente ainda não foi migrado para itens de análise (diferente de um conjunto migrado vazio); nesse caso, as leituras recorrem aos campos legados evaluation/data_collection. - `overrides` (ConversationInitiationClientDataConfigInput, optional) — Substituições adicionais para o agente durante o início da conversa - `workspace_overrides` (AgentWorkspaceOverridesInput, optional) — Substituições do workspace para o agente - `testing` (AgentTestingSettings, optional) — Configuração de teste do agente - `archived` (boolean, optional, default: false) — Se o agente está arquivado. - `guardrails` (GuardrailsV1Input, optional) — Configuração de guardrails do agente - `summary_language` (string, optional) — Idioma para todas as saídas de análise da conversa (resumos, títulos, justificativas de avaliação e justificativas de coleta de dados). Se não for definido, o idioma será inferido da conversa. Deve ser um dos idiomas de conversa compatíveis. - `auto_translate_transcript_to_app_language` (boolean, optional) — Quando ativado, uma transcrição de conversa é traduzida automaticamente para o idioma do aplicativo do visualizador quando ele abre a página de transcrição. Se não estiver definido ou for false, as transcrições serão exibidas no idioma original, a menos que o visualizador selecione uma tradução manualmente. - `auth` (AuthSettings, optional) — Configurações de autenticação - `call_limits` (AgentCallLimits, optional) — Limites de chamadas para o agente - `queueing_config` (AgentQueueingConfig, optional) — Configuração da fila de espera de simultaneidade para o agente - `privacy` (PrivacyConfigInput, optional) — Configurações de privacidade do agente - `trust_context` (enum, optional, default: unknown) — O contexto de confiança em que o agente opera. - Allowed values: `unknown`, `low`, `high` - `analysis_llm` (enum, optional) — Modelo de LLM padrão para análise pós-chamada (avaliação e coleta de dados) - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `topic_discovery` (TopicDiscoverySettings, optional) — Configuração de descoberta de tópicos por agente - `sentiment_analysis` (SentimentAnalysisSettings, optional) — Configuração de análise de sentimento pós-chamada por agente - `alerting` (AlertingSettings, optional) — Configuração de alertas no nível do agente que substitui as configurações do espaço de trabalho. ### AgentWorkflowRequestModel - `edges` (map from string to WorkflowEdgeModelInput, optional) - `nodes` (map from string to AgentWorkflowRequestModelNodesValue, optional) - `prevent_subagent_loops` (boolean, optional, default: false) — Se deve impedir loops na execução do workflow. ### UnitTestRunResponseModelTestInfo - `type`: `llm` - `chat_history` (list of ConversationHistoryTranscriptCommonModelOutput, optional) - `conversation_initiation_source` (enum, optional, default: unknown) — Simule o teste como se a conversa tivesse se originado deste canal. - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool` - `dynamic_variables` (map from string to any, optional) — Variáveis dinâmicas a substituir na configuração do agente durante os testes - `environment` (string, optional) — O ambiente usado para resolver valores de variáveis específicos do ambiente ao executar este teste (URL, cabeçalhos, conexões de autenticação). Se não for fornecido, o padrão será 'production'. Para testes de simulação, simulation_environment terá precedência quando definido. - `failure_examples` (list of AgentFailureResponseExample, optional) — Lista não vazia de respostas de exemplo que devem ser consideradas falhas - `from_conversation_metadata` (TestFromConversationMetadataOutput, optional) — Metadados da conversa a partir da qual este teste foi criado, se aplicável. - `success_condition` (string, optional, default: ) — Um prompt que avalia se a resposta do agente foi bem-sucedida. Deve retornar True ou False. - `success_examples` (list of AgentSuccessfulResponseExample, optional) — Lista não vazia de respostas de exemplo que devem ser consideradas bem-sucedidas - `type`: `simulation` - `chat_history` (list of ConversationHistoryTranscriptCommonModelOutput, optional) - `conversation_initiation_source` (enum, optional, default: unknown) — Simule o teste como se a conversa tivesse se originado deste canal. - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool` - `dynamic_variables` (map from string to any, optional) — Variáveis dinâmicas a substituir na configuração do agente durante os testes - `environment` (string, optional) — O ambiente usado para resolver valores de variáveis específicos do ambiente ao executar este teste (URL, cabeçalhos, conexões de autenticação). Se não for fornecido, o padrão será 'production'. Para testes de simulação, simulation_environment terá precedência quando definido. - `evaluation_model` (enum, optional) — Modelo de LLM a usar para avaliar os resultados da simulação. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `from_conversation_metadata` (TestFromConversationMetadataOutput, optional) — Metadados da conversa a partir da qual este teste foi criado, se aplicável. - `simulated_user_model` (enum, optional) — Modelo de LLM para o usuário simulado. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `simulation_environment` (string, optional) — O ambiente a ser usado ao executar este teste de simulação. Se não for fornecido, o padrão será 'production'. - `simulation_max_turns` (integer, optional, default: 5) — Número máximo de turnos de conversa para testes de simulação. - `simulation_scenario` (string, optional, default: ) — Descrição do cenário de simulação e da persona de usuário para testes de simulação. - `success_conditions` (list of string, optional) — Lista de prompts que avaliam se a simulação foi bem-sucedida. Se fornecidos, todos os critérios são avaliados e combinados em um resultado final. Limitada ao número máximo de critérios de avaliação. - `tool_mock_config` (SimulationToolMockBehaviorConfig, optional) — Configuração das ferramentas a simular e do comportamento de fallback. - `tool_mock_overrides` (map from string to list of ToolResponseMockConfigOutput, optional) — Mocks de resposta específicos do teste, indexados pelo ID da ferramenta. São aplicados antes dos mocks compartilhados da ferramenta e somente neste teste. Só têm efeito para ferramentas simuladas (consulte tool_mock_config). - `success_condition` (string, optional, deprecated) — Critério único de sucesso legado descontinuado. Use success_conditions. Pelo menos um de success_condition ou success_conditions é obrigatório. - `type`: `tool` - `chat_history` (list of ConversationHistoryTranscriptCommonModelOutput, optional) - `check_any_tool_matches` (boolean, optional) — Se definido como True, este teste será aprovado se qualquer chamada de ferramenta retornada pelo LLM corresponder aos critérios. Caso contrário, ele falhará se mais de uma ferramenta for retornada pelo agente. - `conversation_initiation_source` (enum, optional, default: unknown) — Simule o teste como se a conversa tivesse se originado deste canal. - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool` - `dynamic_variables` (map from string to any, optional) — Variáveis dinâmicas a substituir na configuração do agente durante os testes - `environment` (string, optional) — O ambiente usado para resolver valores de variáveis específicos do ambiente ao executar este teste (URL, cabeçalhos, conexões de autenticação). Se não for fornecido, o padrão será 'production'. Para testes de simulação, simulation_environment terá precedência quando definido. - `from_conversation_metadata` (TestFromConversationMetadataOutput, optional) — Metadados da conversa a partir da qual este teste foi criado, se aplicável. - `tool_call_parameters` (UnitTestToolCallEvaluationModelOutput, optional) — Como avaliar a chamada de ferramenta do agente, se houver. Se estiver vazio, a chamada de ferramenta não será avaliada. ### ConversationHistoryTranscriptCommonModelOutput - `role` (enum, required) - Allowed values: `user`, `agent` - `time_in_call_secs` (integer, required) - `agent_metadata` (AgentMetadata, optional) - `message` (string, optional) - `multivoice_message` (ConversationHistoryMultivoiceMessageModel, optional) — Representa uma mensagem de um agente com várias vozes. - `tool_calls` (list of ConversationHistoryTranscriptToolCallCommonModelOutput, optional) - `tool_results` (list of ConversationHistoryTranscriptCommonModelOutputToolResultsItem, optional) - `feedback` (UserFeedback, optional) - `llm_override` (string, optional) - `producing_llm` (string, optional) - `conversation_turn_metrics` (ConversationTurnMetrics, optional) - `rag_retrieval_info` (RagRetrievalInfo, optional) - `llm_usage` (LlmUsageOutput, optional) - `interrupted` (boolean, optional, default: false) - `ignored_as_backchannel` (boolean, optional, default: false) - `platform_event` (enum, optional) - Allowed values: `user_turn_timeout`, `skip_turn_wait_elapsed` - `original_message` (string, optional) - `reasoning` (list of ConversationReasoningModel, optional) - `source_medium` (enum, optional) - Allowed values: `audio`, `dtmf`, `text`, `image`, `file` - `source_event_id` (integer, optional) - `used_static_kb_document_ids` (list of string, optional) - `user_identifier` (string, optional) - `id` (string, optional) - `triggered_guardrails` (list of TriggeredGuardrailCommonModel, optional) ### TestConditionResultCommonModel - `result` (enum, required) - Allowed values: `success`, `failure`, `unknown` - `rationale` (TestConditionRationaleCommonModel, optional) — Justificativa estruturada para os resultados da condição de teste, contendo os motivos individuais de falha/sucesso. ### TestRunMetadata - `workspace_id` (string, required) - `test_name` (string, required) - `ran_by_user_email` (string, required) - `test_type` (enum, optional, default: llm) - Allowed values: `llm`, `tool_call`, `simulation` ### ConversationChargingCommonModel - `dev_discount` (boolean, optional, default: false) - `is_burst` (boolean, optional, default: false) - `tier` (string, optional) - `llm_usage` (LlmCategoryUsage, optional) - `llm_price` (double, optional) - `llm_charge` (integer, optional) - `call_charge` (integer, optional) - `platform_charge` (integer, optional) - `platform_usage` (PlatformUsage, optional) — Detalhamento por categoria de ``platform_charge`` (o equivalente a ``llm_usage``). - `platform_price` (double, optional) - `free_minutes_consumed` (double, optional, default: 0) - `free_llm_dollars_consumed` (double, optional, default: 0) - `tts_usage` (ConversationTtsUsageModel, optional) — Uso agregado de TTS em uma conversa, apenas para análise e não para cobrança. - `asr_usage` (ConversationAsrUsageModel, optional) — Uso agregado de ASR em uma conversa, apenas para análise e não para cobrança. - `analysis` (AnalysisCharging, optional) — Custo de executar a análise pós-chamada nesta conversa. Presente depois que uma análise for executada, seja ela cobrada ou não. ### TestRunResultBucket - `test_run_ids` (list of string, required) - `title` (string, required) — Título curto de uma linha para este bucket - `reason` (string, required) — Resumo breve do motivo pelo qual as execuções de teste neste bucket foram aprovadas ou falharam - `status` (enum, required) - Allowed values: `pending`, `passed`, `failed`, `cancelled` ### ValidationErrorLocItem ### AsrConversationalConfig - `quality` ("high", optional) — A qualidade da transcrição - `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 ### TurnConfig - `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) — 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. - `soft_timeout_config` (SoftTimeoutConfig, optional) — Configuração da funcionalidade de timeout flexível. Fornece feedback imediato durante respostas mais longas da LLM. ### TtsConversationalConfigOutput - `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` - `optimize_streaming_latency` (integer, optional) — Descontinuado: este campo não tem efeito e é ignorado. - `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` (EffectsSpecOutput, optional) — Especificação opcional de efeitos de TTS: predefinição de filtro, distância (EQ de proximidade) e ambiente (reverberação por convolução). ### ConversationConfigOutput - `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) — 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. ### LanguagePresetOutput - `overrides` (ConversationConfigClientOverrideOutput, required) — As substituições da predefinição de idioma - `first_message_translation` (LanguagePresetTranslation, optional) — A tradução da primeira mensagem - `soft_timeout_translation` (LanguagePresetTranslation, optional) — A tradução da mensagem de timeout flexível ### VadConfig ### AgentConfig - `first_message` (string, optional, default: ) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa. - `language` (string, optional, default: en) — Idioma do agente — usado para ASR e TTS - `hinglish_mode` (boolean, optional, default: false) — Quando ativado, o agente mistura palavras e frases em inglês às respostas em hindi, malaiala, telugo ou canarês. - `dynamic_variables` (any, optional) - `disable_first_message_interruptions` (boolean, optional, default: false) — Se for true, o usuário não poderá interromper o agente enquanto a primeira mensagem estiver sendo enviada. - `max_conversation_duration_message` (string, optional, default: ) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida. - `text_behavior_overrides` (map from string to BehaviorOverride, optional) — Substituições do comportamento de resposta por canal para conversas por texto. Os padrões integrados do canal serão aplicados quando não estiver definido. - `prompt` (PromptAgentApiModelOutput, optional) — O prompt do agente ### EvaluationSettingsInput Configurações para avaliar o desempenho de um agente. Os agentes são avaliados com base em um conjunto de critérios, e o sucesso é definido pelo atendimento a alguma combinação desses critérios. - `criteria` (list of PromptEvaluationCriteria, optional) — Critérios individuais pelos quais o agente deve ser avaliado ### WidgetConfig - `variant` (enum, optional, default: full) — A variante do widget - Allowed values: `tiny`, `compact`, `full`, `expandable` - `placement` (enum, optional, default: bottom-right) — O posicionamento do widget na tela - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right` - `expandable` (enum, optional, default: never) — Indica se o widget pode ser expandido - Allowed values: `never`, `mobile`, `desktop`, `always` - `avatar` (WidgetConfigAvatar, optional) — O avatar do widget - `feedback_mode` (enum, optional, default: none) — O modo de feedback do widget - Allowed values: `none`, `during`, `end` - `end_feedback` (WidgetEndFeedbackConfig, optional) — Configuração para feedback coletado ao final da conversa - `bg_color` (string, optional, default: #ffffff) — A cor de fundo do widget - `text_color` (string, optional, default: #000000) — A cor do texto do widget - `btn_color` (string, optional, default: #000000) — A cor do botão do widget - `btn_text_color` (string, optional, default: #ffffff) — A cor do texto do botão do widget - `border_color` (string, optional, default: #e1e1e1) — A cor da borda do widget - `focus_color` (string, optional, default: #000000) — A cor de foco do widget - `border_radius` (integer, optional) — O raio da borda do widget - `btn_radius` (integer, optional) — O raio do botão do widget - `action_text` (string, optional) — O texto de ação do widget - `start_call_text` (string, optional) — O texto de início da chamada do widget - `end_call_text` (string, optional) — O texto de encerramento da chamada do widget - `expand_text` (string, optional) — O texto de expansão do widget - `listening_text` (string, optional) — O texto a ser exibido quando o agente estiver ouvindo - `speaking_text` (string, optional) — O texto a ser exibido quando o agente estiver falando - `shareable_page_text` (string, optional) — O texto a ser exibido ao compartilhar - `shareable_page_show_terms` (boolean, optional, default: true) — Se deve mostrar os termos e condições na página compartilhável - `terms_text` (string, optional) — O texto a ser exibido nos termos e condições - `terms_html` (string, optional) — O HTML a exibir para os termos e condições - `terms_key` (string, optional) — A chave a ser exibida para os termos e condições - `show_avatar_when_collapsed` (boolean, optional) — Se deve mostrar o avatar quando o widget estiver recolhido - `disable_banner` (boolean, optional, default: false) — Indica se deve desativar o banner - `override_link` (string, optional) — O link de substituição para o widget - `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Lista de nomes de host permitidos para links clicáveis em Markdown. Use \{ hostname: '\*' } para permitir qualquer domínio. Vazio significa que nenhum link é permitido. - `markdown_link_include_www` (boolean, optional, default: true) — Indica se deve incluir automaticamente variantes com www. dos hosts permitidos - `markdown_link_allow_http` (boolean, optional, default: true) — Indica se deve permitir http:// além de https:// para hosts permitidos - `mic_muting_enabled` (boolean, optional, default: true) — Indica se deve ativar o silenciamento do microfone - `transcript_enabled` (boolean, optional, default: true) — Indica se o widget deve mostrar a transcrição da conversa à medida que ela ocorre - `text_input_enabled` (boolean, optional, default: true) — Indica se o usuário deve poder enviar mensagens de texto - `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Indica se deve ativar o controle de alternância do modo de conversa no widget - `default_expanded` (boolean, optional, default: false) — Indica se o widget deve ser expandido por padrão - `always_expanded` (boolean, optional, default: false) — Indica se o widget deve permanecer sempre expandido - `dismissible` (boolean, optional, default: false) — Indica se o usuário pode fechar o widget - `show_agent_status` (boolean, optional, default: false) — Se deve mostrar o status de trabalhando/concluído/erro do agente durante o uso da ferramenta - `show_conversation_id` (boolean, optional, default: true) — Se deve mostrar o ID da conversa após a desconexão. - `strip_audio_tags` (boolean, optional, default: true) — Se deve remover a marcação de áudio das mensagens. - `syntax_highlight_theme` (enum, optional) — Tema para destaque de sintaxe em blocos de código. Por padrão, o widget detecta automaticamente quando não é definido. - Allowed values: `light`, `dark` - `text_contents` (WidgetTextContents, optional) — Conteúdo de texto do widget - `styles` (WidgetStyles, optional) — Estilos do widget - `show_resize_button` (boolean, optional, default: true) — Se deve mostrar o botão de redimensionamento - `end_confirmation_enabled` (boolean, optional, default: false) — Se deve pedir ao usuário que confirme antes de encerrar um chat ou uma chamada - `language_selector` (boolean, optional, default: false) — Se deve mostrar o seletor de idioma - `supports_text_only` (boolean, optional, default: true) — Indica se o widget pode alternar para o modo somente texto - `custom_avatar_path` (string, optional) — O caminho do avatar personalizado - `language_presets` (map from string to WidgetLanguagePreset, optional) — Predefinições de idioma para o widget ### AnalysisProperty Propriedade de coleta de dados com substituição opcional de LLM por item para análise pós-chamada. TODO: migrar para composição (value_schema: LiteralJsonSchemaProperty + llm) em vez de herança, para que isso seja generalizado adequadamente para esquemas de objeto/array no futuro. - `type` (enum, required) - Allowed values: `boolean`, `string`, `integer`, `number` - `description` (string, optional, default: ) — A descrição da propriedade. Quando definida, o LLM fornecerá o valor com base nesta descrição. Mutuamente exclusiva com dynamic_variable, is_system_provided, constant_value e is_omitted. - `enum` (list of string, optional) — List of allowed string values for string type parameters - `is_system_provided` (boolean, optional, default: false) — Se for true, o valor será preenchido pelo sistema em tempo de execução. Usado por ferramentas de Webhook de integração de API para criação de templates. Mutuamente exclusivo com description, dynamic_variable, constant_value e is_omitted. - `dynamic_variable` (string, optional, default: ) — O nome da variável dinâmica a ser usada para o valor desta propriedade. Mutuamente exclusivo com description, is_system_provided, constant_value e is_omitted. - `allowed_values` (AllowedValues, optional) — Proteção de rejeição no servidor para um valor fornecido por um LLM: o runtime rejeita qualquer valor fora do conjunto permitido nomeado por este objeto, e o conjunto não é apresentado ao LLM como um enum. Compatível apenas quando a origem do valor é `description`; combiná-la com dynamic_variable, is_system_provided, constant_value ou is_omitted é rejeitado. - `constant_value` (AnalysisPropertyConstantValue, optional) — Um valor constante para usar nesta propriedade. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e constant_value. - `name` (string, optional) — O nome deste item de coleta de dados. - `llm` (enum, optional) — Modelo de LLM a usar neste item de análise. Se não for definido, usa o padrão analysis_llm do agente. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `allowed_values_dynamic_variable` (string, optional, default: , deprecated) — DESCONTINUADO: use `allowed_values`. Quando definido, o LLM fornece o valor, mas o tempo de execução rejeita qualquer valor que não esteja na lista mantida por esta variável dinâmica (deve ser um array JSON, como ["ws_alpha", "ws_beta"]). Use para permitir que o LLM escolha de um conjunto verificado pelo servidor (por exemplo, os IDs aos quais o usuário atual tem permissão de acesso). Exige descrição; mutuamente exclusivo com dynamic_variable, is_system_provided, constant_value e is_omitted. ### AgentAnalysisItemsInput - `evaluation_criteria` (list of AgentAnalysisItemsInputEvaluationCriteriaItem, optional) - `data_collection` (list of AgentAnalysisItemsInputDataCollectionItem, optional) ### ConversationInitiationClientDataConfigInput - `conversation_config_override` (ConversationConfigClientOverrideConfigInput, optional) — Substituições para a configuração da conversa - `custom_llm_extra_body` (boolean, optional, default: false) — Indica se deve incluir corpo adicional personalizado do LLM - `enable_conversation_initiation_client_data_from_webhook` (boolean, optional, default: false) — Indica se deve ativar dados de cliente para início de conversa a partir de webhooks - `enable_starting_workflow_node_id_from_client` (boolean, optional, default: false) — Se os clientes podem enviar starting_workflow_node_id nos dados de início do cliente; se false, enviá-lo impede o início da conversa. - `enable_procedure_ids_from_client` (boolean, optional, default: false) — Se os clientes podem enviar procedure_ids nos dados de início do cliente para selecionar quais procedimentos do agente estão disponíveis para a conversa; se false, enviá-los impede o início da conversa. ### AgentWorkspaceOverridesInput - `conversation_initiation_client_data_webhook` (ConversationInitiationClientDataWebhook, optional) — O webhook para o qual enviar dados do cliente de início da conversa - `webhooks` (ConvAiWebhooks, optional) ### AgentTestingSettings Configurações para testes de agentes. - `attached_tests` (list of AttachedTestModel, optional) — Lista de IDs de testes que devem ser executados para este agente ### GuardrailsV1Input - `version` ("1", optional) - `focus` (FocusGuardrail, optional) - `prompt_injection` (PromptInjectionGuardrail, optional) - `content` (ContentGuardrailInput, optional) - `custom` (CustomGuardrailInput, optional) — Contêiner para guardrails personalizados, correspondente ao padrão ModerationGuardrail ### AuthSettings - `enable_auth` (boolean, optional, default: false) — Se definido como true, iniciar uma conversa com um agente exigirá um token assinado - `allowlist` (list of AllowlistItem, optional) — Uma lista de hosts autorizados a iniciar conversas com o agente. - `require_origin_header` (boolean, optional, default: false) — Quando ativado, conexões sem o cabeçalho de origem serão rejeitadas. Se a lista de permissões estiver vazia, esta opção não terá efeito. - `shareable_token` (string, optional) — Um token compartilhável que pode ser usado para iniciar uma conversa com o agente ### 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. ### AgentQueueingConfig - `enabled` (boolean, optional, default: false) — Mantenha os chamadores em uma fila de espera quando o agente atingir o limite de simultaneidade, em vez de rejeitá-los imediatamente. Novos agentes são criados com o enfileiramento ativado, a menos que este campo seja definido explicitamente. - `wait_timeout_seconds` (integer, optional, default: 180) — Tempo máximo que uma pessoa pode aguardar na fila antes de ser rejeitada - `hold_audio` (AgentHoldAudioConfig, optional) — Áudio de espera personalizado reproduzido para pessoas na fila; quando não definido, elas ouvem o tom de espera padrão. Somente leitura: defina-o enviando um arquivo pelo endpoint de áudio de espera do agente. ### PrivacyConfigInput - `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 ### TopicDiscoverySettings Configuração de descoberta de tópicos por agente. A cadência e a janela de análise são gerenciadas internamente; isto expõe apenas o botão de ativação/desativação voltado ao cliente. ### SentimentAnalysisSettings ### AlertingSettings Configuração de alertas usada tanto no nível do agente quanto no do espaço de trabalho. Ordem em cascata para o limite e a resolução automática por monitor: agente → espaço de trabalho → padrão do sistema. - `monitor_configs` (map from string to AlertingMonitorConfig, optional) — Configuração de alertas indexada pelo nome do monitor. - `auto_resolve_after_inactive_minutes` (integer, optional) — Por quantos minutos um alerta pode permanecer inativo antes de ser resolvido automaticamente. Valores não definidos usam a próxima camada. - `notifiers` (list of AlertingSettingsNotifiersItem, optional) — Canais de entrega para notificações do ciclo de vida de alertas. Combinados com outras camadas e deduplicados por ``webhook_id``, ``connection_id`` do PagerDuty ou ``(connection_id, channel_id)`` do Slack. ### WorkflowEdgeModelInput - `source` (string, required) — ID do nó de origem. - `target` (string, required) — ID do nó de destino. - `forward_condition` (WorkflowEdgeModelInputForwardCondition, optional) — Condição que deve ser atendida para que a aresta seja percorrida na direção direta (da origem para o destino). - `backward_condition` (WorkflowEdgeModelInputBackwardCondition, optional) — Condição que deve ser atendida para que a aresta seja percorrida na direção inversa (do destino para a origem). ### AgentWorkflowRequestModelNodesValue - `type`: `end` - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `outcome` (enum, optional, default: success) — Se chegar a este nó End encerra a conversa com sucesso ou falha. - Allowed values: `success`, `failure` - `position` (PositionInput, optional) — Posição do nó no workflow. - `type`: `override_agent` - `label` (string, required) — Rótulo legível para humanos do nó, usado em toda a interface. - `additional_knowledge_base` (list of KnowledgeBaseLocator, optional) — Documentos adicionais da base de conhecimento aos quais o subagente tem acesso. Eles serão usados além dos documentos do agente principal. - `additional_prompt` (string, optional) — Objetivo específico deste subagente. Ele será adicionado ao prompt do sistema e pode ser usado para refinar ainda mais o comportamento do agente neste contexto específico. - `additional_tool_ids` (list of string, optional) — IDs de ferramentas adicionais às quais o subagente tem acesso. Elas serão usadas além das ferramentas do agente principal. - `conversation_config` (ConversationalConfigApiModelWorkflowOverrideInput, optional) — Substituições de configuração aplicadas enquanto o subagente conduz a conversa. - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `entry_behavior` (enum, optional, default: auto) — Define se este nó deve gerar uma resposta imediatamente ao ser acessado ou aguardar a entrada do usuário. Quando definido como "auto", o comportamento será decidido com base no tipo do nó anterior: "wait_for_user" após os nós "say" e "start" e "generate_immediately" nos demais casos. - Allowed values: `generate_immediately`, `wait_for_user`, `auto` - `position` (PositionInput, optional) — Posição do nó no workflow. - `type`: `phone_number` - `transfer_destination` (WorkflowPhoneNumberNodeModelInputTransferDestination, required) - `custom_sip_headers` (list of WorkflowPhoneNumberNodeModelInputCustomSipHeadersItem, optional) — Cabeçalhos SIP personalizados a serem incluídos ao transferir a chamada. Cada cabeçalho pode ser um valor estático ou uma referência a variável dinâmica. - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `position` (PositionInput, optional) — Posição do nó no workflow. - `post_dial_digits` (WorkflowPhoneNumberNodeModelInputPostDialDigits, optional) — Dígitos DTMF a enviar após a conexão da chamada, por exemplo, 'ww1234' para ramal. Pode ser um valor estático ou uma referência de variável dinâmica. Use 'w' para uma pausa de 0,5 s. Compatível apenas com transferências do Twilio. - `sip_refer_play_dialtone` (boolean, optional, default: true) — Quando True, um tom de chamada é reproduzido na perna original da chamada enquanto uma transferência SIP REFER é concluída. O tom é transmitido por RTP ao par SIP que executa o REFER, portanto desative esta opção se o sistema receptor (por exemplo, um SBC ou central de atendimento) não deve ouvi-lo. Quando desativada, a pessoa que ligou ouve silêncio até a transferência ser concluída. Apenas para transferências SIP REFER. - `transfer_type` (enum, optional, default: conference) - Allowed values: `blind`, `conference`, `sip_refer` - `uui` (UuiTransferConfig, optional) — Informações de Usuário para Usuário (RFC 7433) a serem anexadas a transferências SIP REFER. Transporta o contexto da chamada, como identificadores de CRM ou motivo de escalonamento, durante a transferência. - `type`: `standalone_agent` - `agent_id` (string, optional) — O ID do agente para o qual transferir a conversa. None significa transferir dentro do agente atual. - `branch_id` (string, optional) — ID opcional da ramificação do agente de destino. None segue a implantação de tráfego do agente de destino ou usa sua ramificação principal quando node_id está definido. - `delay_ms` (integer, optional, default: 0) — Atraso artificial em milissegundos aplicado antes de transferir a conversa. - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `enable_transferred_agent_first_message` (boolean, optional, default: false) — Indica se deve permitir que o agente transferido envie sua primeira mensagem configurada após a transferência. - `node_id` (string, optional) — ID opcional do nó de destino no workflow do agente de destino. Quando definido, a transferência começa nesse nó, em vez do nó de entrada padrão. - `position` (PositionInput, optional) — Posição do nó no workflow. - `preserve_client_tts_overrides` (boolean, optional, default: false) — Define se as substituições do cliente de TTS devem ser mantidas no agente transferido. - `preserve_voice_settings` (boolean, optional, default: false) — Define se a voz base, o modelo TTS e as configurações de voz devem ser transferidos para o agente transferido. - `transfer_message` (string, optional) — Mensagem opcional enviada ao usuário antes do início da transferência. - `type`: `start` - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `position` (PositionInput, optional) — Posição do nó no workflow. - `type`: `tool` - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `position` (PositionInput, optional) — Posição do nó no workflow. - `tools` (list of WorkflowToolLocator, optional) — Lista de ferramentas para executar em paralelo. Todo o nó é considerado bem-sucedido se todas as ferramentas forem executadas com sucesso. - `type`: `say` - `label` (string, required) — Rótulo legível para humanos do nó, usado em toda a interface. - `message` (WorkflowSayNodeModelInputMessage, required) — Mensagem falada por este nó. Use `literal` para texto exato ou `prompt` para que o LLM gere a mensagem a partir de uma descrição. - `additional_knowledge_base` (list of KnowledgeBaseLocator, optional) — Documentos da base de conhecimento disponíveis ao LLM enquanto este nó gera sua mensagem, além dos documentos do agente. - `additional_prompt` (string, optional) — Aceito para manter a consistência com nós de subagentes, mas não é usado. Descreva a mensagem em `message.prompt` ou substitua o prompt do sistema por `conversation_config.agent.prompt.prompt`. - `additional_tool_ids` (list of string, optional) — Aceito para manter a consistência com nós de subagentes, mas não é usado. Um nó say não pode chamar ferramentas. - `conversation_config` (ConversationalConfigApiModelWorkflowOverrideInput, optional) — Substituições de configuração aplicadas enquanto este nó fala, como a voz ou, para mensagens de prompt, o LLM e o prompt do sistema. - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `position` (PositionInput, optional) — Posição do nó no workflow. - `wait_for_speech_completion` (boolean, optional, default: false) — Quando for true, o workflow só segue para o próximo nó depois que a mensagem for totalmente falada. - `wait_for_user_response` (boolean, optional, default: false) — Quando for true, o nó fala sua mensagem e espera a resposta do usuário antes de avaliar as arestas de saída, para que elas possam seguir caminhos diferentes com base na resposta. Se o usuário permanecer em silêncio, o workflow avança após o tempo limite do turno. - `type`: `update_state` - `label` (string, required) — Rótulo legível para humanos do nó, usado em toda a interface. - `updates` (list of WorkflowStateUpdateInput, required) — Atualizações de estado aplicadas quando o workflow chega a este nó. Um nó aceita no máximo 50 atualizações. - `edge_order` (list of string, optional) — Os IDs das arestas de saída na ordem em que devem ser avaliadas. - `position` (PositionInput, optional) — Posição do nó no workflow. ### AgentFailureResponseExample - `response` (string, required) - `type` ("failure", required) ### TestFromConversationMetadataOutput - `conversation_id` (string, required) - `agent_id` (string, required) - `branch_id` (string, optional) - `workflow_node_id` (string, optional) - `original_agent_reply` (list of ConversationHistoryTranscriptCommonModelOutput, optional, default: []) ### AgentSuccessfulResponseExample - `response` (string, required) - `type` ("success", required) ### SimulationToolMockBehaviorConfig Configuração do lado da simulação/prévia: as ferramentas são identificadas por IDs e resolvidas para nomes em tempo de execução. - `mocking_strategy` (enum, optional, default: none) — Quais ferramentas simular: 'all' simula todas as ferramentas que podem ser simuladas, 'selected' simula apenas as presentes em mocked_tool_names/mocked_tool_ids, e 'none' desativa a simulação. - Allowed values: `all`, `selected`, `none` - `fallback_strategy` (enum, optional, default: raise_error) — Comportamento quando nenhum mock corresponde a uma chamada de ferramenta. - Allowed values: `call_real_tool`, `raise_error` - `mocked_tool_ids` (list of string, optional) — IDs de ferramentas a serem simuladas. São resolvidos para nomes de ferramentas antes de serem enviados ao orquestrador. ### ToolResponseMockConfigOutput - `mock_result` (string, required) — O valor retornado que o LLM vê quando este mock está ativo. - `parameter_conditions` (list of UnitTestToolCallParameter, optional) — Se a lista estiver vazia, o mock sempre será ativado. - `is_error` (boolean, optional, default: false) — Se for true, o resultado do mock será apresentado ao LLM como um erro da ferramenta, em vez de um resultado bem-sucedido. ### UnitTestToolCallEvaluationModelOutput - `parameters` (list of UnitTestToolCallParameter, optional) — Parâmetros a serem avaliados para a chamada de ferramenta do agente. Se estiver vazio, os parâmetros da chamada de ferramenta não serão avaliados. - `referenced_tool` (ReferencedToolCommonModel, optional) — A ferramenta em relação à qual avaliar uma chamada. - `verify_absence` (boolean, optional, default: false) — Se deve verificar que a ferramenta NÃO foi chamada. - `workflow_node_transition` (UnitTestWorkflowNodeTransitionEvaluationNodeId, optional) — Configuração para testar transições de nós do workflow. Quando definida, o teste verificará se o agente faz a transição para o nó de workflow especificado. ### AgentMetadata - `agent_id` (string, required) - `branch_id` (string, optional) - `workflow_node_id` (string, optional) - `version_id` (string, optional) ### ConversationHistoryMultivoiceMessageModel Representa uma mensagem de um agente com várias vozes. - `parts` (list of ConversationHistoryMultivoiceMessagePartModel, required) ### ConversationHistoryTranscriptToolCallCommonModelOutput - `request_id` (string, required) - `tool_name` (string, required) - `params_as_json` (string, required) - `tool_has_been_called` (boolean, required) - `type` (enum, optional) - Allowed values: `system`, `webhook`, `client`, `mcp`, `workflow`, `api_integration_webhook`, `api_integration_mcp`, `smb` - `tool_id` (string, optional) — ID da ferramenta chamada. Não definido para ferramentas sem ID, como ferramentas do sistema. - `tool_details` (ConversationHistoryTranscriptToolCallCommonModelOutputToolDetails, optional) ### ConversationHistoryTranscriptCommonModelOutputToolResultsItem ### UserFeedback - `score` (enum, required) - Allowed values: `like`, `dislike` - `time_in_call_secs` (integer, required) ### ConversationTurnMetrics - `metrics` (map from string to MetricRecord, optional) - `convai_asr_provider` (string, optional) - `convai_tts_model` (string, optional) - `convai_tts_cascade` (string, optional) - `voice_id` (string, optional) ### RagRetrievalInfo - `chunks` (list of RagChunkMetadata, required) - `embedding_model` (enum, required, default: e5_mistral_7b_instruct) - Allowed values: `e5_mistral_7b_instruct`, `multilingual_e5_large_instruct` - `retrieval_query` (string, required) - `rag_latency_secs` (double, required) - `used_chunk_ids` (list of string, optional) ### LlmUsageOutput - `model_usage` (map from string to LlmInputOutputTokensUsage, optional) ### ConversationReasoningModel - `summary` (string, optional) - `provider_redact` (boolean, optional, default: false) ### TriggeredGuardrailCommonModel - `guardrail_type` (enum, required) - Allowed values: `custom`, `prompt_injection`, `self_harm_intent`, `violence_graphic`, `sexual`, `violence`, `harassment`, `sexual_minors`, `self_harm`, `self_harm_instructions`, `harassment_threatening`, `hate`, `hate_threatening`, `profanity`, `religion_or_politics`, `medical_and_legal`, `guardrail` - `guardrail_name` (string, optional) ### TestConditionRationaleCommonModel Justificativa estruturada para os resultados da condição de teste, contendo os motivos individuais de falha/sucesso. - `messages` (list of string, optional) — Lista de mensagens ou motivos de avaliação de parâmetros individuais - `summary` (string, optional, default: ) — Resumo de alto nível do resultado da avaliação ### LlmCategoryUsage - `irreversible_generation` (LlmUsageOutput, optional) - `initiated_generation` (LlmUsageOutput, optional) ### PlatformUsage Detalhamento por categoria de ``platform_charge`` (o equivalente a ``llm_usage``). - `category_usage` (map from string to PlatformCategoryUsage, optional) ### ConversationTtsUsageModel Uso agregado de TTS em uma conversa, apenas para análise e não para cobrança. - `primary_tts_model` (string, optional) - `total_audio_output_seconds` (double, optional, default: 0) - `total_characters` (integer, optional, default: 0) - `per_voice_usage` (list of ConversationVoiceUsageModel, optional) ### ConversationAsrUsageModel Uso agregado de ASR em uma conversa, apenas para análise e não para cobrança. - `asr_model` (string, optional) - `total_transcription_calls` (integer, optional, default: 0) - `total_audio_input_seconds` (double, optional, default: 0) ### AnalysisCharging Custo de executar a análise pós-chamada nesta conversa. Presente depois que uma análise for executada, seja ela cobrada ou não. - `total` (AnalysisRunningTotal, required) — Custo acumulado do LLM para executar a análise pós-chamada nesta conversa. - `last_run` (AnalysisRunSnapshot, required) — Custo de LLM da análise pós-chamada mais recente desta conversa. ### SoftTimeoutConfig Configuração da funcionalidade de timeout flexível durante a geração de respostas da LLM. - `timeout_seconds` (double, optional, default: -1) — Tempo em segundos antes de exibir a mensagem predefinida enquanto aguarda a resposta do LLM. Defina como -1 para desativar. - `message` (string, optional, default: Hhmmmm...yeah.) — Mensagem a exibir quando o primeiro tempo limite flexível for atingido durante a espera pela resposta do LLM. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}). - `additional_soft_timeout_messages` (list of string, optional) — Mensagens estáticas extras de preenchimento para os soft timeouts subsequentes na mesma geração de LLM. O primeiro timeout usa `message`. Se houver menos mensagens configuradas que `max_soft_timeouts_per_generation`, a última mensagem configurada será repetida; caso contrário, será usada uma mensagem de preenchimento integrada. - `use_llm_generated_message` (boolean, optional, default: false) — Se ativado, a mensagem de timeout suave será gerada dinamicamente em vez de usar a mensagem estática. - `randomize_fillers` (boolean, optional, default: false) — Se ativado, embaralha uma vez a ordem das mensagens estáticas de timeout suave no início de cada turno. Aplica-se apenas quando use_llm_generated_message é false. - `max_soft_timeouts_per_generation` (integer, optional, default: 1) — Número máximo de mensagens de preenchimento durante a espera por uma única resposta do LLM. É acionado a cada timeout_seconds até que o LLM transmita conteúdo ou esse limite seja atingido. - `llm_generated_message_prompt_override` (string, optional) — Prompt personalizado para gerar a mensagem de preenchimento de tempo limite flexível quando use\_llm\_generated\_message estiver ativado. O contexto recente da conversa é fornecido como uma mensagem de usuário separada. Se não for definido, o prompt padrão será usado. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}). - `disable_until_first_user_message` (boolean, optional, default: false) — Quando true, os preenchimentos de timeout flexível são suprimidos até que a conversa tenha pelo menos uma mensagem real do usuário. Isso evita preenchimentos durante o turno de abertura do agente (por exemplo, workflow generate-immediately ou chamadas de ferramenta antes de o usuário falar). ### SupportedVoice - `label` (string, required) - `voice_id` (string, required) - `description` (string, optional) - `language` (string, optional) - `model_family` (enum, optional) - Allowed values: `turbo`, `flash`, `multilingual`, `v3_conversational`, `v4`, `v4_turbo` - `optimize_streaming_latency` (integer, optional) - `stability` (double, optional) - `speed` (double, optional) - `similarity_boost` (double, optional) ### SuggestedAudioTag - `tag` (string, required) — Tag de áudio a usar (para melhor desempenho, 1 a 2 palavras, por exemplo, 'feliz', 'animado') - `description` (string, optional) — 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, optional) — O ID da versão do dicionário de pronúncia ### EffectsSpecOutput 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. - `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. - `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. - `filter_preset_id` (string, optional) — 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`. - `environment_id` (string, optional) — 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) — 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`. ### 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` ("preset", optional) — O tipo de fonte de som de fundo. - `source_id` (enum, optional) — 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. ### ConversationConfigClientOverrideOutput - `asr` (AsrConversationalConfigOverride, optional) — Configuração para transcrição conversacional - `turn` (TurnConfigOverride, optional) — Configuração para detecção de turnos - `tts` (TtsConversationalConfigOverride, optional) — Configuração para Text to Speech conversacional - `conversation` (ConversationConfigOverride, optional) — Configuração para eventos de conversa - `agent` (AgentConfigOverrideOutput, optional) — Configuração específica do agente ### LanguagePresetTranslation - `source_hash` (string, required) - `text` (string, required) ### BehaviorOverride - `verbosity` (enum, optional) — Substituição de verbosidade. O padrão subjacente é aplicado quando não definido. - Allowed values: `auto`, `concise`, `thorough` - `output_format` (enum, optional) — Substituição do formato de saída. O padrão subjacente será aplicado quando não estiver definido. - Allowed values: `mp3_22050_32`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_44100`, `ulaw_8000` - `interaction_budget` (enum, optional) — Substituição do orçamento de interação. O padrão subjacente é aplicado quando não definido. - Allowed values: `realtime`, `5_minutes`, `10_minutes`, `1_hour` ### PromptAgentApiModelOutput - `prompt` (string, optional, default: ) — O prompt do agente - `llm` (enum, optional) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `reasoning_effort` (enum, optional) — Esforço de raciocínio do modelo. Disponível apenas para alguns modelos. - Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max` - `thinking_budget` (integer, optional) — Número máximo de tokens usados para raciocínio. Use 0 para desativar, se houver suporte do modelo. - `enable_reasoning_summary` (boolean, optional, default: false) — Ative resumos de raciocínio do modelo. Quando desativado, não solicitamos resumos ao provedor, quando possível, para obter um TTFB mais rápido. Não é compatível com ZRM. - `temperature` (double, optional) — A temperatura para o LLM. O padrão é 0. Defina como null para omitir totalmente o parâmetro da solicitação ao LLM, o que é útil para LLMs personalizados que rejeitam o campo de temperatura. - `max_tokens` (integer, optional, default: -1) — Se for maior que 0, número máximo de tokens que o LLM pode prever - `tool_ids` (list of string, optional) — Uma lista de IDs das ferramentas usadas pelo agente. - `tool_ids_strict` (boolean, optional, default: false) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente. - `built_in_tools` (BuiltInToolsOutput, optional) — Ferramentas de sistema integradas a serem usadas pelo agente - `enable_parallel_tool_calls` (boolean, optional, default: true) — Ative chamadas paralelas de ferramentas. Quando ativado, o agente pode executar várias ferramentas em paralelo em um único turno. Não é compatível com todos os modelos. - `mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP a serem usados pelo agente - `native_mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente - `knowledge_base` (list of KnowledgeBaseLocator, optional) — Uma lista de bases de conhecimento a serem usadas pelo agente - `custom_llm` (CustomLlm, optional) — Definição de um LLM personalizado se o campo LLM estiver definido como 'CUSTOM_LLM' - `ignore_default_personality` (boolean, optional) — Se deve remover as linhas de personalidade padrão do prompt do sistema - `rag` (RagConfigOutput, optional) — Configuração para RAG - `timezone` (string, optional) — Fuso horário para exibir a hora atual no prompt do sistema. Se definido, a hora atual será incluída no prompt do sistema usando esse fuso horário. Deve ser um nome de fuso horário válido (por exemplo, 'America/New_York', 'Europe/London', 'UTC'). Recomendado para respostas precisas que consideram o horário; sem isso, o agente não tem conhecimento da data/hora atual, a menos que você a forneça por meio de variáveis dinâmicas ou ferramentas, o que pode levar a referências de tempo incorretas ou alucinadas. - `backup_llm_config` (PromptAgentApiModelOutputBackupLlmConfig, optional) — Configuração da cascata de LLMs de backup. Pode ser desativada, usar os padrões do sistema ou especificar uma ordem personalizada. - `cascade_timeout_seconds` (double, optional, default: 4) — Tempo em segundos antes de alternar para o LLM de backup. Deve estar entre 2 e 15 segundos. - `tools` (list of PromptAgentApiModelOutputToolsItem, optional, deprecated) — Uma lista de ferramentas que o agente pode usar durante a conversa; use tool_ids em vez disso ### PromptEvaluationCriteria Uma avaliação que usa a transcrição e um prompt para uma resposta de sim/não sobre o resultado alcançado - `id` (string, required) — O identificador exclusivo dos critérios de avaliação - `name` (string, required) - `conversation_goal_prompt` (string, required) — O prompt que o agente deve usar para avaliar a conversa - `type` ("prompt", optional) — O tipo de critério de avaliação - `use_knowledge_base` (boolean, optional, default: false) — Se a base de conhecimento do agente deve ser usada ao avaliar o prompt. - `scope` (enum, optional, default: conversation) — O escopo do contexto da transcrição usado ao avaliar este critério. 'conversation' usa a transcrição completa; 'agent' usa apenas a parte em que o agente definido estava ativo. - Allowed values: `conversation`, `agent` - `llm` (enum, optional) — Modelo de LLM a usar neste critério de avaliação. Se não for definido, usa o padrão analysis_llm do agente. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `scoring_mode` (enum, optional, default: binary) — Como este critério é pontuado. 'binary' resulta em êxito/falha/desconhecido. 'numeric_uniform' retorna um número na escala [0, max_score], normalizado para a porcentagem agregada de êxito da conversa. - Allowed values: `binary`, `numeric_uniform` - `max_score` (integer, optional, default: 100) — Valor máximo da escala de pontuação numérica (o mínimo é sempre 0). Usado apenas quando scoring_mode é 'numeric_uniform'. - `score_instructions` (string, optional) — Instruções opcionais em texto livre que descrevem como atribuir valores na escala numérica. Usadas apenas quando scoring_mode é 'numeric_uniform'. ### WidgetConfigAvatar O avatar do widget - `type`: `orb` - `color_1` (string, optional, default: #2792dc) — A primeira cor do avatar - `color_2` (string, optional, default: #9ce6e6) — A segunda cor do avatar - `type`: `url` - `custom_url` (string, optional, default: ) — A URL personalizada do avatar - `type`: `image` - `url` (string, optional, default: ) — A URL do avatar ### WidgetEndFeedbackConfig - `type` ("rating", optional) — O tipo de feedback a ser coletado ao final da conversa ### AllowlistItem - `hostname` (string, required) — O nome do host da origem permitida ### WidgetTextContents - `main_label` (string, optional) — Chamada para ação exibida nas variantes compacta e completa. - `start_call` (string, optional) — Texto e rótulo ARIA do botão de iniciar chamada. - `start_chat` (string, optional) — Texto e rótulo ARIA do botão de iniciar chat (somente texto) - `new_call` (string, optional) — Texto e rótulo ARIA do botão de nova chamada. Exibido quando a pessoa que liga já concluiu pelo menos uma chamada para iniciar a próxima. - `end_call` (string, optional) — Texto e rótulo ARIA do botão de encerrar chamada. - `mute_microphone` (string, optional) — Rótulo ARIA do botão de silenciar o microfone. - `change_language` (string, optional) — Rótulo ARIA do menu suspenso de alteração de idioma. - `collapse` (string, optional) — Rótulo ARIA do botão de recolher. - `expand` (string, optional) — Rótulo ARIA do botão de expandir. - `copied` (string, optional) — Texto exibido quando o usuário copia um valor usando o botão de copiar. - `accept_terms` (string, optional) — Texto e rótulo ARIA do botão de aceitar os termos. - `dismiss_terms` (string, optional) — Texto e rótulo ARIA do botão de cancelar os termos. - `listening_status` (string, optional) — Status exibido quando o agente está ouvindo. - `speaking_status` (string, optional) — Status exibido quando o agente está falando. - `connecting_status` (string, optional) — Status exibido quando o agente está se conectando. - `chatting_status` (string, optional) — Status exibido quando o agente está conversando por chat (somente texto) - `queue_waiting_status` (string, optional) — Status exibido enquanto aguarda na fila por um agente disponível. - `queue_waiting_status_short` (string, optional) — Status curto exibido enquanto aguarda um agente disponível. - `input_label` (string, optional) — Rótulo ARIA da entrada de mensagem de texto. - `input_placeholder` (string, optional) — Texto de placeholder para a entrada de mensagem de texto. - `input_placeholder_text_only` (string, optional) — Texto de placeholder para a entrada de mensagem de texto (somente texto) - `input_placeholder_new_conversation` (string, optional) — Texto de placeholder para a entrada de mensagem de texto ao iniciar uma nova conversa (somente texto) - `user_ended_conversation` (string, optional) — Mensagem informativa exibida quando o usuário encerra a conversa. - `agent_ended_conversation` (string, optional) — Mensagem informativa exibida quando o agente encerra a conversa. - `conversation_id` (string, optional) — Rótulo de texto usado ao lado do ID da conversa. - `error_occurred` (string, optional) — Rótulo de texto usado quando ocorre um erro. - `queue_timed_out` (string, optional) — Mensagem de erro exibida quando o tempo de espera na fila se esgota. - `copy_id` (string, optional) — Texto e rótulo ARIA usados no botão de copiar ID. - `initiate_feedback` (string, optional) — Texto exibido para solicitar feedback ao usuário. - `request_follow_up_feedback` (string, optional) — Texto exibido para solicitar detalhes adicionais do feedback. - `thanks_for_feedback` (string, optional) — Texto exibido para agradecer ao usuário por fornecer feedback. - `thanks_for_feedback_details` (string, optional) — Texto adicional exibido que explica o valor do feedback do usuário. - `follow_up_feedback_placeholder` (string, optional) — Texto de placeholder para o campo de entrada de feedback complementar. - `submit` (string, optional) — Texto e rótulo ARIA do botão de enviar. - `go_back` (string, optional) — Texto e rótulo ARIA do botão de voltar. - `send_message` (string, optional) — Texto e rótulo ARIA do botão de enviar mensagem. - `text_mode` (string, optional) — Texto e rótulo ARIA do botão de alternar para o modo texto. - `voice_mode` (string, optional) — Texto e rótulo ARIA do botão de alternar para o modo voz. - `switched_to_text_mode` (string, optional) — Notificação toast exibida ao alternar para o modo de texto. - `switched_to_voice_mode` (string, optional) — Notificação toast exibida ao alternar para o modo de voz. - `copy` (string, optional) — Texto e rótulo ARIA do botão de copiar. - `download` (string, optional) — Texto e rótulo ARIA do botão de download. - `wrap` (string, optional) — Texto e rótulo ARIA do botão de alternar quebra de linha. - `agent_working` (string, optional) — Texto de status exibido enquanto o agente processa uma chamada de ferramenta. - `agent_done` (string, optional) — Texto de status exibido quando o agente termina de processar uma chamada de ferramenta. - `agent_error` (string, optional) — Texto de status exibido quando o agente encontra um erro durante uma chamada de ferramenta. - `attach_file` (string, optional) — Texto e rótulo ARIA do botão de anexar arquivo. - `remove_file` (string, optional) — Rótulo ARIA do botão de remover arquivo. - `file_upload_error` (string, optional) — Mensagem de erro exibida quando o upload de um arquivo falha. - `file_type_unsupported` (string, optional) — Mensagem de erro exibida quando um tipo de arquivo não compatível é selecionado. Seguida da lista de tipos aceitos. - `file_too_large` (string, optional) — Mensagem de erro exibida quando um arquivo excede o limite máximo de tamanho. - `file_limit_reached` (string, optional) — Mensagem de erro exibida quando o número máximo de arquivos para uma conversa é atingido. - `typing_indicator` (string, optional) — Texto de status exibido enquanto o agente está digitando. - `rich_content_unavailable` (string, optional) — Mensagem alternativa exibida quando o conteúdo avançado não pode ser renderizado. ### WidgetStyles - `base` (string, optional) — A cor de fundo base. - `base_hover` (string, optional) — A cor do plano de fundo base ao passar o cursor. - `base_active` (string, optional) — A cor do plano de fundo base quando ativo (clicado). - `base_border` (string, optional) — A cor da borda sobre o plano de fundo base. - `base_subtle` (string, optional) — A cor do texto secundário sobre o plano de fundo base. - `base_primary` (string, optional) — A cor do texto principal sobre o plano de fundo base. - `base_error` (string, optional) — A cor do texto de erro sobre o plano de fundo base. - `accent` (string, optional) — A cor de fundo de destaque. - `accent_hover` (string, optional) — A cor do plano de fundo de destaque ao passar o cursor. - `accent_active` (string, optional) — A cor do plano de fundo de destaque quando ativo (clicado). - `accent_border` (string, optional) — A cor da borda sobre o plano de fundo de destaque. - `accent_subtle` (string, optional) — A cor do texto secundário sobre o plano de fundo de destaque. - `accent_primary` (string, optional) — A cor do texto principal sobre o plano de fundo de destaque. - `overlay_padding` (double, optional) — O espaçamento interno nas bordas da área de visualização. - `button_radius` (double, optional) — O raio dos botões. - `input_radius` (double, optional) — O raio dos campos de entrada. - `bubble_radius` (double, optional) — O raio dos balões de chat. - `sheet_radius` (double, optional) — O raio padrão das folhas. - `compact_sheet_radius` (double, optional) — O raio do painel no modo compacto. - `dropdown_sheet_radius` (double, optional) — O raio do painel suspenso. ### WidgetLanguagePreset - `text_contents` (WidgetTextContents, optional) — O conteúdo de texto para o idioma selecionado - `text_contents_translation` (WidgetTextContentsTranslation, optional) — O cache de tradução dos conteúdos de texto - `terms_text` (string, optional) — O texto a ser exibido nos termos e condições neste idioma - `terms_html` (string, optional) — O HTML a exibir para os termos e condições neste idioma - `terms_key` (string, optional) — A chave a ser exibida para os termos e condições neste idioma - `terms_translation` (WidgetTermsTranslation, optional) — O cache de tradução dos termos ### AllowedValues - `dynamic_variable` (string, required) — Nome de uma variável dinâmica que deve resultar em uma matriz JSON de valores permitidos, por exemplo, ["ws_alpha", "ws_beta"]. As variáveis do sistema funcionam apenas se resultarem em uma lista. ### AnalysisPropertyConstantValue Um valor constante para usar nesta propriedade. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e is_omitted. ### AgentAnalysisItemsInputEvaluationCriteriaItem - `source`: `system` - `analysis_item_id` (enum, required) — ID da avaliação do sistema integrado referenciada. - Allowed values: `__system_eval_criteria_sentiment`, `__system_eval_criteria_frustration` - `scope` (enum, optional, default: conversation) — Contexto da transcrição ('conversation' ou 'agent') usado ao executar este item. - Allowed values: `conversation`, `agent` - `weight` (double, optional) — Peso relativo opcional para a pontuação agregada. - `source`: `user` - `analysis_item_id` (string, required) — ID do item de avaliação do usuário referenciado. - `additional_version_ids` (list of string, optional) — Versões extras de itens para também executar para comparação (A/B). Elas são executadas e armazenadas, mas excluídas da pontuação; a version_id principal é a que recebe pontuação. - `scope` (enum, optional, default: conversation) — Contexto da transcrição ('conversation' ou 'agent') usado ao executar este item. - Allowed values: `conversation`, `agent` - `version_id` (string, optional) — Versão principal do item cujo resultado alimenta a pontuação. None acompanha a versão publicada mais recente do item. - `weight` (double, optional) — Peso relativo opcional para a pontuação agregada. ### AgentAnalysisItemsInputDataCollectionItem - `source`: `system` - `analysis_item_id` ("__system_data_collection_topic", required) — ID do item de coleta de dados do sistema integrado referenciado. - `scope` (enum, optional, default: conversation) — Contexto da transcrição ('conversation' ou 'agent') usado ao executar este item. - Allowed values: `conversation`, `agent` - `source`: `user` - `analysis_item_id` (string, required) — ID do item de coleta de dados do usuário referenciado. - `scope` (enum, optional, default: conversation) — Contexto da transcrição ('conversation' ou 'agent') usado ao executar este item. - Allowed values: `conversation`, `agent` - `version_id` (string, optional) — Versão fixada do item. None acompanha a versão publicada mais recente do item. ### ConversationConfigClientOverrideConfigInput - `asr` (AsrConversationalConfigOverrideConfig, optional) — Configura substituições para campos aninhados. - `turn` (TurnConfigOverrideConfig, optional) — Configura substituições para campos aninhados. - `tts` (TtsConversationalConfigOverrideConfig, optional) — Configura substituições para campos aninhados. - `conversation` (ConversationConfigOverrideConfig, optional) — Configura substituições para campos aninhados. - `agent` (AgentConfigOverrideConfig, optional) — Configura substituições para campos aninhados. ### ConversationInitiationClientDataWebhook - `url` (string, required) — A URL para a qual enviar o webhook - `request_headers` (map from string to ConversationInitiationClientDataWebhookRequestHeadersValue, required) — Os cabeçalhos a enviar com a solicitação de webhook ### ConvAiWebhooks - `post_call_webhook_id` (string, optional) - `events` (list of enum, optional) — Lista de tipos de evento a enviar via webhook. Opções: transcript, audio, call_initiation_failure, answering_machine_detection, unredacted_transcript, unredacted_audio. - Allowed values: `transcript`, `audio`, `call_initiation_failure`, `answering_machine_detection`, `unredacted_transcript`, `unredacted_audio` - `transcript_format` (enum, optional, default: json) — Formato para webhooks de transcrição. - Allowed values: `json`, `opentelemetry` - `exclude_transcript` (boolean, optional, default: false) — Quando true, os webhooks JSON de transcrição pós-chamada omitem a transcrição de cada turno. A análise, os metadados e outros campos da conversa ainda são enviados. Ignorado para o formato de transcrição OpenTelemetry. - `send_audio` (boolean, optional, deprecated) — DESCONTINUADO: use o campo 'events'. Define se dados de áudio devem ser enviados com webhooks pós-chamada para conversas do ConvAI. ### AttachedTestModel - `test_id` (string, required) - `workflow_node_id` (string, optional) ### FocusGuardrail - `is_enabled` (boolean, optional, default: false) ### PromptInjectionGuardrail - `is_enabled` (boolean, optional, default: false) ### ContentGuardrailInput - `execution_mode` (enum, optional, default: streaming) - Allowed values: `streaming`, `blocking` - `config` (ContentConfig, optional) - `trigger_action` (ContentGuardrailInputTriggerAction, optional) ### CustomGuardrailInput Contêiner para guardrails personalizados, correspondente ao padrão ModerationGuardrail - `config` (CustomGuardrailsConfigInput, optional) — Contêiner de configuração para lista de guardrails personalizados ### AgentHoldAudioConfig Áudio de espera personalizado reproduzido em loop para pessoas que aguardam na fila do agente. Definido ao enviar um arquivo pelo endpoint de áudio de espera do agente. Os valores enviados em solicitações de criação ou atualização do agente são ignorados. - `audio_path` (string, required) — Caminho de armazenamento do clipe enviado - `audio_url` (string, required) — URL pública da CDN do clipe enviado - `original_filename` (string, required) — Nome do arquivo do clipe enviado, conforme fornecido pelo usuário - `duration_secs` (double, required) — Duração do clipe enviado, em segundos - `size_bytes` (integer, required) — Tamanho do clipe enviado em bytes ### 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. ### AlertingMonitorConfig - `enabled` (boolean, optional) — Indica se este monitor está ativado e pode enviar notificações - `threshold` (double, optional) — Limite de taxa de falha a partir do qual este monitor pode enviar notificações. - `relative_increase_threshold` (double, optional) — Aumento relativo em relação à linha de base anterior a partir do qual este monitor pode enviar uma notificação (0.2 = 20% acima da linha de base; 0 = qualquer falha). Para conversation_volume_drop, é a parcela do volume habitual que deve estar ausente, entre 0.1 e 0.9 (0.5 = metade). - `min_failure_count` (integer, optional) — Número mínimo de falhas na janela antes que este monitor possa ser acionado. - `min_history_bucket_count` (integer, optional) — Número mínimo de buckets finais com tráfego antes que a detecção de picos possa ser acionada. - `min_sample_count` (integer, optional) — Número mínimo de amostras na janela antes que este monitor possa ser acionado. - `suspect_trigger_threshold` (integer, optional) — Quantos buckets suspeitos dentro da janela de análise são necessários para transformar uma suspeita em alerta. - `auto_resolve_after_inactive_minutes` (integer, optional) — Por quantos minutos um alerta pode permanecer inativo antes de ser resolvido automaticamente. ### AlertingSettingsNotifiersItem - `type`: `webhook` - `webhook_id` (string, required) — ID do webhook do workspace para o qual serão enviadas notificações do ciclo de vida de alertas. - `type`: `integration` - `connection_id` (string, required) — ID da conexão de integração do workspace para a qual serão enviadas notificações do ciclo de vida de alertas. A integração da conexão deve ter capacidade de monitoramento e corresponder a ``integration_type``. - `channel_id` (string, optional) — ID do canal do Slack em que as notificações de alerta serão publicadas, por exemplo, ``C0123456789``. Obrigatório quando ``integration_type`` é ``slack``. O app do Slack deve ser membro do canal e ter o escopo ``chat:write`` ou ``chat:write.public`` para canais públicos dos quais não participa. - `integration_type` (enum, optional) — Integração para a qual entregar. O servidor trata um valor omitido como ``pagerduty``. - Allowed values: `pagerduty`, `slack` ### WorkflowEdgeModelInputForwardCondition - `type`: `expression` - `expression` (AstNodeInput, required) — Expressão a avaliar. - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `llm` - `condition` (string, required) — Condição a avaliar - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `result` - `successful` (boolean, required) — Se todas as ferramentas no nó de ferramenta executado anteriormente foram executadas com sucesso. - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `unconditional` - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. ### WorkflowEdgeModelInputBackwardCondition - `type`: `expression` - `expression` (AstNodeInput, required) — Expressão a avaliar. - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `llm` - `condition` (string, required) — Condição a avaliar - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `result` - `successful` (boolean, required) — Se todas as ferramentas no nó de ferramenta executado anteriormente foram executadas com sucesso. - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. - `type`: `unconditional` - `label` (string, optional) — Rótulo opcional legível para humanos da condição, usado em toda a interface. ### PositionInput - `x` (double, optional, default: 0) - `y` (double, optional, default: 0) ### KnowledgeBaseLocator - `type` (enum, required) — O tipo da base de conhecimento - Allowed values: `file`, `url`, `text`, `folder` - `name` (string, required) — O nome da base de conhecimento - `id` (string, required) — O ID da base de conhecimento - `usage_mode` (enum, optional, default: auto) — O modo de uso da base de conhecimento - Allowed values: `prompt`, `auto` ### ConversationalConfigApiModelWorkflowOverrideInput - `asr` (AsrConversationalConfigWorkflowOverride, optional) — Configuração para transcrição conversacional - `turn` (TurnConfigWorkflowOverride, optional) — Configuração para detecção de turnos - `tts` (TtsConversationalConfigWorkflowOverrideInput, optional) — Configuração para Text to Speech conversacional - `conversation` (ConversationConfigWorkflowOverrideInput, optional) — Configuração para eventos de conversa - `language_presets` (map from string to LanguagePresetInput, optional) — Predefinições de idioma para conversas - `vad` (VadConfigWorkflowOverride, optional) — Configuração para detecção de atividade de voz - `agent` (AgentConfigApiModelWorkflowOverrideInput, optional) — Configuração específica do agente ### WorkflowPhoneNumberNodeModelInputTransferDestination - `type`: `phone` - `phone_number` (string, required) - `type`: `phone_dynamic_variable` - `phone_number` (string, required) - `type`: `sip_uri` - `sip_uri` (string, required) - `type`: `sip_uri_dynamic_variable` - `sip_uri` (string, required) ### WorkflowPhoneNumberNodeModelInputCustomSipHeadersItem - `type`: `dynamic` - `key` (string, required) — O nome do cabeçalho SIP (por exemplo, 'X-Customer-ID') - `value` (string, required) — O nome da variável dinâmica a ser resolvida - `type`: `static` - `key` (string, required) — O nome do cabeçalho SIP (por exemplo, 'X-Customer-ID') - `value` (string, required) — O valor do cabeçalho ### WorkflowPhoneNumberNodeModelInputPostDialDigits - `type`: `dynamic` - `value` (string, required) — O nome da variável dinâmica a ser resolvida - `type`: `static` - `value` (string, required) — Dígitos DTMF a enviar após a conexão da chamada, por exemplo, 'ww1234' para ramal ### UuiTransferConfig Envelope de Informações de Usuário para Usuário para transferências SIP REFER (RFC 7433). Os payloads de saída são codificados em hexadecimal (a única codificação definida pela RFC 7433). O campo discriminador de protocolo permite que formatos por plataforma (Talkdesk, Genesys, ...) sejam definidos por configuração, em vez de sinalizadores de transferência dispersos. Outros campos (codificação ASCII, nome do cabeçalho, parâmetros de finalidade/conteúdo) podem ser adicionados aqui sem alterar o modelo de transferência. - `data` (string, required) — Payload UUI a ser enviado em transferências SIP REFER. Compatível com variáveis dinâmicas inline e codificado em hexadecimal no momento da transferência. - `protocol_discriminator` (string, optional) — Discriminador opcional de protocolo de um octeto (dois dígitos hexadecimais, por exemplo, '00'). Exigido por plataformas como Genesys Cloud, que, caso contrário, removem o primeiro octeto da carga útil. Deixe sem definir para plataformas como Talkdesk, que esperam uma carga útil hexadecimal sem delimitadores. - `protocol_discriminator_mode` (enum, optional, default: prefix) — Como anexar protocol\_discriminator. 'prefix' adiciona o octeto antes do payload hexadecimal (User-to-User=XX\;encoding=hex). 'pd\_parameter' o envia como um parâmetro separado (User-to-User=\;pd=XX;encoding=hex). Ignorado quando protocol\_discriminator não está definido. - Allowed values: `prefix`, `pd_parameter` ### WorkflowToolLocator - `tool_id` (string, required) - `schema_overrides` (map from string to WorkflowToolLocatorSchemaOverridesValue, optional) — Substituições de parâmetros por nó aplicadas sobre a configuração da própria ferramenta. As chaves são caminhos de parâmetros separados por ponto (ferramentas de webhook prefixam as chaves com path_params./query_params./request_body.). Elas têm prioridade sobre quaisquer substituições já definidas na própria ferramenta. ### WorkflowSayNodeModelInputMessage Mensagem falada por este nó. Use `literal` para texto exato ou `prompt` para que o LLM gere a mensagem a partir de uma descrição. - `type`: `literal` - `text` (string, required) — Texto exato falado pelo agente. Compatível com espaços reservados de variáveis dinâmicas `{{variable_name}}`. - `text_translations` (map from string to TranslatedString, optional) — Traduções de `text`, organizadas por código de idioma. Quando o idioma da conversa tem uma entrada, o valor dela é falado em vez de `text`. - `type`: `prompt` - `prompt` (string, required) — Descrição da mensagem que o LLM deve gerar. Ela é adicionada ao prompt do sistema do agente enquanto este nó está ativo. ### WorkflowStateUpdateInput - `variable_name` (string, required) — Nome da variável dinâmica a ser atribuída. - `expression` (AstNodeInput, required) — Expressão cujo resultado é atribuído à variável. Ela pode combinar constantes, outras variáveis dinâmicas, valores extraídos pelo LLM e operadores. - `type` ("dynamic_variable", optional) - `required` (boolean, optional, default: true) — Quando for false, o LLM pode omitir os valores dos quais esta atualização depende. Nesse caso, a atualização é ignorada e a variável mantém o valor atual. ### UnitTestToolCallParameter - `eval` (UnitTestToolCallParameterEval, required) - `path` (string, required) ### ReferencedToolCommonModel Referência a uma ferramenta para avaliação de teste unitário. - `id` (string, required) — O ID da ferramenta - `type` (enum, required) — O tipo da ferramenta - Allowed values: `system`, `webhook`, `client`, `workflow`, `api_integration_webhook`, `mcp`, `code` ### UnitTestWorkflowNodeTransitionEvaluationNodeId - `agent_id` (string, required) — O ID do agente cujo workflow contém o nó de destino. - `target_node_id` (string, required) — O ID do nó do workflow para o qual o agente deve fazer a transição. - `type` ("node_id", optional) ### ConversationHistoryMultivoiceMessagePartModel Representa uma única parte de voz de uma mensagem com várias vozes. - `text` (string, required) - `voice_label` (string, optional) - `time_in_call_secs` (integer, optional) ### ConversationHistoryTranscriptToolCallCommonModelOutputToolDetails - `type`: `api_integration_webhook` - `credential_id` (string, required, default: ) - `integration_connection_id` (string, required, default: ) - `integration_id` (string, required, default: ) - `webhook_details` (ConversationHistoryTranscriptToolCallWebhookDetails, required) - `type`: `client` - `parameters` (string, required) - `type`: `mcp` - `approval_policy` (string, required) - `integration_type` (string, required) - `mcp_server_id` (string, required) - `mcp_server_name` (string, required) - `mcp_tool_description` (string, optional, default: ) - `mcp_tool_name` (string, optional, default: ) - `parameters` (map from string to string, optional) - `requires_approval` (boolean, optional, default: false) - `type`: `webhook` - `method` (string, required) - `url` (string, required) - `body` (string, optional) - `headers` (map from string to string, optional) - `path_params` (map from string to string, optional) - `query_params` (map from string to string, optional) ### ConversationHistoryTranscriptOtherToolsResultCommonModel - `request_id` (string, required) - `tool_name` (string, required) - `result_value` (string, required) - `is_error` (boolean, required) - `tool_has_been_called` (boolean, required) - `is_blocked` (boolean, optional, default: false) - `tool_latency_secs` (double, optional, default: 0) - `error_type` (string, optional, default: ) - `raw_error_message` (string, optional, default: ) - `dynamic_variable_updates` (list of DynamicVariableUpdateCommonModel, optional) - `type` (enum, optional) - Allowed values: `client`, `webhook`, `mcp`, `code` ### ConversationHistoryTranscriptSystemToolResultCommonModelOutput - `request_id` (string, required) - `tool_name` (string, required) - `result_value` (string, required) - `is_error` (boolean, required) - `tool_has_been_called` (boolean, required) - `type` ("system", required) - `is_blocked` (boolean, optional, default: false) - `tool_latency_secs` (double, optional, default: 0) - `error_type` (string, optional, default: ) - `raw_error_message` (string, optional, default: ) - `dynamic_variable_updates` (list of DynamicVariableUpdateCommonModel, optional) - `result` (ConversationHistoryTranscriptSystemToolResultCommonModelOutputResult, optional) ### ConversationHistoryTranscriptApiIntegrationWebhookToolsResultCommonModelOutput - `request_id` (string, required) - `tool_name` (string, required) - `result_value` (string, required) - `is_error` (boolean, required) - `is_blocked` (boolean, required, default: false) - `tool_has_been_called` (boolean, required) - `tool_latency_secs` (double, required, default: 0) - `error_type` (string, required, default: ) - `raw_error_message` (string, required, default: ) - `dynamic_variable_updates` (list of DynamicVariableUpdateCommonModel, required) - `type` ("api_integration_webhook", required) - `integration_id` (string, required, default: ) - `credential_id` (string, required, default: ) - `integration_connection_id` (string, required, default: ) ### ConversationHistoryTranscriptWorkflowToolsResultCommonModelOutput - `request_id` (string, required) - `tool_name` (string, required) - `result_value` (string, required) - `is_error` (boolean, required) - `tool_has_been_called` (boolean, required) - `type` ("workflow", required) - `is_blocked` (boolean, optional, default: false) - `tool_latency_secs` (double, optional, default: 0) - `error_type` (string, optional, default: ) - `raw_error_message` (string, optional, default: ) - `dynamic_variable_updates` (list of DynamicVariableUpdateCommonModel, optional) - `result` (WorkflowToolResponseModelOutput, optional) — Um modelo comum para respostas de ferramentas de workflow. ### MetricRecord - `elapsed_time` (double, required) ### RagChunkMetadata - `document_id` (string, required) - `chunk_id` (string, required) - `vector_distance` (double, required) ### LlmInputOutputTokensUsage - `input` (LlmTokensCategoryUsage, optional) - `input_cache_read` (LlmTokensCategoryUsage, optional) - `input_cache_write` (LlmTokensCategoryUsage, optional) - `output_total` (LlmTokensCategoryUsage, optional) ### PlatformCategoryUsage Cobrança acumulada para uma única :class:`PlatformCategory`. - `credits` (integer, optional, default: 0) - `price` (double, optional, default: 0) - `quantity` (double, optional, default: 0) ### ConversationVoiceUsageModel - `voice_id` (string, required) - `audio_output_seconds` (double, optional, default: 0) ### AnalysisRunningTotal Custo acumulado do LLM para executar a análise pós-chamada nesta conversa. - `price` (double, optional, default: 0) - `charge` (integer, optional, default: 0) - `runs` (integer, optional, default: 0) - `price_per_feature` (map from string to double, optional) - `charge_per_feature` (map from string to integer, optional) ### AnalysisRunSnapshot Custo de LLM da análise pós-chamada mais recente desta conversa. - `price` (double, optional, default: 0) - `charge` (integer, optional, default: 0) - `price_per_feature` (map from string to double, optional) - `charge_per_feature` (map from string to integer, optional) ### AsrConversationalConfigOverride - `keywords` (list of string, optional) — Palavras-chave para aumentar a probabilidade de previsão ### TurnConfigOverride - `soft_timeout_config` (SoftTimeoutConfigOverride, optional) — Configuração da funcionalidade de timeout flexível. Fornece feedback imediato durante respostas mais longas da LLM. ### TtsConversationalConfigOverride - `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) — O ID da voz a usar para TTS - `supported_voices` (list of SupportedVoice, optional) — Vozes adicionais compatíveis com o agente - `stability` (double, optional) — A estabilidade da fala gerada - `speed` (double, optional) — A velocidade da fala gerada - `similarity_boost` (double, optional) — O aumento de similaridade para a fala gerada - `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional) — Os localizadores do dicionário de pronúncia ### ConversationConfigOverride - `text_only` (boolean, optional) — 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) — A duração máxima de uma conversa em segundos ### AgentConfigOverrideOutput - `first_message` (string, optional) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa. - `language` (string, optional) — Idioma do agente — usado para ASR e TTS - `max_conversation_duration_message` (string, optional) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida. - `prompt` (PromptAgentApiModelOverrideOutput, optional) — O prompt do agente ### BuiltInToolsOutput Ferramentas do sistema que podem ser fornecidas a um agente conversacional. Deliberadamente não recebe o nome de ConversationalBuiltInTools: BuiltInToolsInput e BuiltInToolsOutput fazem parte da especificação pública da API e dos SDKs gerados. - `transfer_to_agent` (SystemToolConfigOutput, optional) — A ferramenta de transferência para agente - `end_call` (SystemToolConfigOutput, optional) — A ferramenta de encerramento da chamada - `language_detection` (SystemToolConfigOutput, optional) — A ferramenta de detecção de idioma - `transfer_to_number` (SystemToolConfigOutput, optional) — A ferramenta de transferência para número - `skip_turn` (SystemToolConfigOutput, optional) — A ferramenta para pular turno - `play_keypad_touch_tone` (SystemToolConfigOutput, optional) — A ferramenta de reprodução DTMF - `voicemail_detection` (SystemToolConfigOutput, optional) — A ferramenta de detecção de caixa postal ### CustomLlm - `url` (string, required) — A URL do endpoint compatível com Chat Completions - `model_id` (string, optional) — O ID do modelo a ser usado se a URL disponibilizar vários modelos - `api_key` (CustomLlmApiKey, optional) — A chave de API para autenticação. Pode ser uma referência a um segredo do workspace \{'secret\_id': '...'} ou uma referência a uma variável de ambiente \{'env\_var\_label': '...'}. - `auth_connection` (CustomLlmAuthConnection, optional) — Conexão de autenticação opcional do workspace. Só há suporte para conexões de autenticação que produzem um token Authorization Bearer; não há suporte para conexões de autenticação Basic, mTLS, cabeçalho personalizado e segredo de URL. - `request_headers` (map from string to CustomLlmRequestHeadersValue, optional) — Cabeçalhos que devem ser incluídos na solicitação - `api_version` (string, optional) — A versão da API a ser usada na solicitação - `api_type` (enum, optional, default: chat_completions) — O tipo de API a ser usado (chat_completions, responses ou websocket) - Allowed values: `chat_completions`, `responses`, `websocket` ### RagConfigOutput - `enabled` (boolean, optional, default: false) - `embedding_model` (enum, optional, default: e5_mistral_7b_instruct) - Allowed values: `e5_mistral_7b_instruct`, `multilingual_e5_large_instruct` - `max_vector_distance` (double, optional, default: 0.6) — Distância vetorial máxima dos trechos recuperados. - `max_documents_length` (integer, optional, default: 50000) — Comprimento total máximo dos trechos de documentos recuperados do RAG. - `max_retrieved_rag_chunks_count` (integer, optional, default: 20) — Número máximo de trechos de documentos RAG a recuperar inicialmente do armazenamento vetorial. Eles são então filtrados ainda mais pela distância vetorial e pelo comprimento total. - `num_candidates` (integer, optional) — Número de candidatos avaliados na busca vetorial ANN. Um número maior significa melhores resultados, mas maior latência. O valor mínimo recomendado é 100. Se desativado, o valor padrão será usado. - `query_rewrite_prompt_override` (string, optional) — Prompt personalizado para reescrever consultas do usuário antes da recuperação RAG. O histórico da conversa será anexado automaticamente ao final. Se não for definido, o prompt padrão será usado. - `knowledge_base_tool_info` (KnowledgeBaseToolInfo, optional) — Quando definido, o agente usa a ferramenta knowledge_base em vez da ferramenta legada knowledge_base_rag. None significa que o agente não aderiu. ### PromptAgentApiModelOutputBackupLlmConfig Configuração da cascata de LLMs de backup. Pode ser desativada, usar os padrões do sistema ou especificar uma ordem personalizada. - `preference`: `default` - `preference`: `disabled` - `preference`: `override` - `order` (list of enum, required) - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` ### PromptAgentApiModelOutputToolsItem O tipo de ferramenta - `type`: `api_integration_webhook` - `api_integration_connection_id` (string, required) - `api_integration_id` (string, required) - `assignments` (list of DynamicVariableAssignment, required) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `dynamic_variables` (DynamicVariablesConfig, required) — Configuração para variáveis dinâmicas - `execution_mode` (enum, required, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `interruption_mode` (enum, required, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `name` (string, required) - `pre_tool_speech` (enum, required, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, required, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. Deve estar entre 5 e 300 segundos, inclusive. - `tool_call_sound_behavior` (enum, required, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, required, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `tool_version` (string, required, default: 1.0.0) — A versão da ferramenta de integração da API - `disable_interruptions` (boolean, required, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, required, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `api_schema_overrides` (ApiIntegrationWebhookOverrides, optional) — Substituições do usuário aplicadas sobre o api_schema base - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `type`: `client` - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `name` (string, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `dynamic_variables` (DynamicVariablesConfig, optional) — Configuração para variáveis dinâmicas - `execution_mode` (enum, optional, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `expects_response` (boolean, optional, default: false) — Se for true, a chamada desta ferramenta deverá bloquear a conversa até que o cliente responda, e essa resposta será passada ao LLM. Se for false, continuaremos a conversa sem esperar a resposta do cliente. Isso é útil para mostrar conteúdo a um usuário sem bloquear a conversa. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `parameters` (ObjectJsonSchemaPropertyOutput, optional) — Schema para quaisquer parâmetros a serem enviados ao cliente - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, de espera pela conclusão da chamada da ferramenta. Deve ser entre 1 e 120 segundos (inclusive) ou -1 para aguardar indefinidamente a resposta do cliente (requer expects_response). - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `type`: `mcp` - `value` (any, required) - `type`: `smb` - `value` (any, required) - `type`: `system` - `name` (string, required) - `params` (SystemToolConfigOutputParams, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `description` (string, optional, default: ) — Descrição de quando a ferramenta deve ser usada e do que ela faz. Deixe em branco para usar a descrição padrão otimizada para o tipo específico de ferramenta. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `type`: `webhook` - `api_schema` (WebhookToolApiSchemaConfigOutput, required) — O esquema do webhook de saída, incluindo parâmetros e especificação de URL - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `name` (string, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `dynamic_variables` (DynamicVariablesConfig, optional) — Configuração para variáveis dinâmicas - `execution_mode` (enum, optional, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `follow_redirects` (boolean, optional, default: false) — Se deve seguir um redirecionamento do endpoint e retornar a resposta final. Um redirecionamento é seguido como um GET sem o corpo da solicitação; nenhuma configuração desta ferramenta (cabeçalhos, autenticação, certificado de cliente) é enviada ao destino do redirecionamento. Tanto o endpoint quanto o destino do redirecionamento devem usar HTTPS. Não é compatível com ferramentas de integração de API. - `follow_redirects_allowed_domains` (list of string, optional) — Domínios para os quais um redirecionamento pode apontar, por exemplo, 'test.example.com'. Obrigatório ao seguir redirecionamentos; um destino fora da lista será recusado. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. Deve estar entre 5 e 300 segundos, inclusive. - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. ### WidgetTextContentsTranslation - `source` (map from string to string, optional) — O texto de origem do qual cada campo traduzido foi derivado - `text` (map from string to string, optional) — A última saída traduzida automaticamente para cada campo traduzido ### WidgetTermsTranslation - `source_hash` (string, required) - `text` (string, required) ### AsrConversationalConfigOverrideConfig - `keywords` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo keywords. ### TurnConfigOverrideConfig - `soft_timeout_config` (SoftTimeoutConfigOverrideConfig, optional) — Configura substituições para campos aninhados. ### TtsConversationalConfigOverrideConfig - `model_id` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo model_id. - `voice_id` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo voice_id. - `supported_voices` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo supported_voices. - `stability` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo stability. - `speed` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo speed. - `similarity_boost` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo similarity_boost. - `pronunciation_dictionary_locators` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo pronunciation_dictionary_locators. ### ConversationConfigOverrideConfig - `text_only` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo text_only. - `max_duration_seconds` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo max_duration_seconds. ### AgentConfigOverrideConfig - `first_message` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo first_message. - `language` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo language. - `max_conversation_duration_message` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo max_conversation_duration_message. - `prompt` (PromptAgentApiModelOverrideConfig, optional) — Configura substituições para campos aninhados. ### ConversationInitiationClientDataWebhookRequestHeadersValue ### ContentConfig - `sexual` (ContentThresholdGuardrail, optional) - `violence` (ContentThresholdGuardrail, optional) - `harassment` (ContentThresholdGuardrail, optional) - `self_harm` (ContentThresholdGuardrail, optional) - `profanity` (ContentThresholdGuardrail, optional) - `religion_or_politics` (ContentThresholdGuardrail, optional) - `medical_and_legal_information` (ContentThresholdGuardrail, optional) ### ContentGuardrailInputTriggerAction - `type`: `end_call` - `type`: `retry` - `feedback` (string, optional, default: Your response was blocked by a guardrail that blocks content that matches this condition/category: '{{trigger_reason}}' During your next turn you must tell the user "I'm sorry but I can't answer that question, would you like to know something else?".) — Feedback personalizado a ser inserido no agente ao tentar novamente após o acionamento de uma proteção. ### CustomGuardrailsConfigInput Contêiner de configuração para lista de guardrails personalizados - `configs` (list of CustomGuardrailConfig, optional) ### AstNodeInput - `type`: `add_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `and_operator` - `children` (list of AstNodeInput, required) — Nós filhos do operador lógico. - `type`: `boolean_literal` - `value` (boolean, required) — Valor deste literal. - `type`: `conditional_operator` - `condition` (AstNodeInput, required) — Condição que decide qual expressão deve ser selecionada. - `falseExpression` (AstNodeInput, required) — Expressão selecionada se a condição for false. - `trueExpression` (AstNodeInput, required) — Expressão selecionada se a condição for true. - `type`: `div_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `dynamic_variable` - `name` (string, required) — O nome da variável dinâmica. - `type`: `eq_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `gt_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `gte_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `llm` - `value_schema` (LlmLiteralJsonSchemaProperty, optional) — Esquema JSON que descreve o valor que o LLM deve extrair. - `prompt` (string, optional, deprecated) — O prompt a ser avaliado como um valor booleano. Descontinuado. Use um esquema booleano. - `type`: `lt_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `lte_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `mul_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `neq_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. - `type`: `null_literal` - `type`: `number_literal` - `value` (AstNumberNodeInputValue, required) — Valor deste literal. - `type`: `or_operator` - `children` (list of AstNodeInput, required) — Nós filhos do operador lógico. - `type`: `string_literal` - `value` (string, required) — Valor deste literal. - `type`: `sub_operator` - `left` (AstNodeInput, required) — Operando esquerdo do operador binário. - `right` (AstNodeInput, required) — Operando direito do operador binário. ### AsrConversationalConfigWorkflowOverride - `quality` ("high", optional) — A qualidade da transcrição - `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 ### TurnConfigWorkflowOverride - `turn_timeout` (double, optional) — Tempo máximo de espera pela resposta do usuário antes de retomar o contato - `initial_wait_time` (double, optional) — 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) — 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) — 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) — 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) — 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) — 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. - `soft_timeout_config` (SoftTimeoutConfigWorkflowOverride, optional) — Configuração da funcionalidade de timeout flexível. Fornece feedback imediato durante respostas mais longas da LLM. ### TtsConversationalConfigWorkflowOverrideInput - `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) — 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) — 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` - `optimize_streaming_latency` (integer, optional) — Descontinuado: este campo não tem efeito e é ignorado. - `stability` (double, optional) — A estabilidade da fala gerada - `speed` (double, optional) — A velocidade da fala gerada - `similarity_boost` (double, optional) — 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) — 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` (EffectsSpecInput, optional) — Especificação opcional de efeitos de TTS: predefinição de filtro, distância (EQ de proximidade) e ambiente (reverberação por convolução). ### ConversationConfigWorkflowOverrideInput - `text_only` (boolean, optional) — 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) — 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` (FileInputConfigWorkflowOverride, optional) — Configuração para entrada de arquivos (uploads de imagens/PDFs) durante conversas. - `monitoring_enabled` (boolean, optional) — 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) — Configure a coleta de entrada DTMF (teclado) durante chamadas telefônicas - `background_sound` (BackgroundSoundConfigWorkflowOverride, optional) — Configuração do som de fundo durante conversas. - `source_attribution` (boolean, optional) — Quando ativado e houver conteúdo na base de conhecimento, o LLM é instruído a informar quais fontes utilizou. ### LanguagePresetInput - `overrides` (ConversationConfigClientOverrideInput, required) — As substituições da predefinição de idioma - `first_message_translation` (LanguagePresetTranslation, optional) — A tradução da primeira mensagem - `soft_timeout_translation` (LanguagePresetTranslation, optional) — A tradução da mensagem de timeout flexível ### VadConfigWorkflowOverride ### AgentConfigApiModelWorkflowOverrideInput - `first_message` (string, optional) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa. - `language` (string, optional) — Idioma do agente — usado para ASR e TTS - `hinglish_mode` (boolean, optional) — Quando ativado, o agente mistura palavras e frases em inglês às respostas em hindi, malaiala, telugo ou canarês. - `dynamic_variables` (DynamicVariablesConfigWorkflowOverride, optional) — Configuração para variáveis dinâmicas - `disable_first_message_interruptions` (boolean, optional) — Se for true, o usuário não poderá interromper o agente enquanto a primeira mensagem estiver sendo enviada. - `max_conversation_duration_message` (string, optional) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida. - `text_behavior_overrides` (map from string to BehaviorOverride, optional) — Substituições do comportamento de resposta por canal para conversas por texto. Os padrões integrados do canal serão aplicados quando não estiver definido. - `prompt` (PromptAgentApiModelWorkflowOverrideInput, optional) — O prompt do agente ### WorkflowToolLocatorSchemaOverridesValue - `source`: `constant` - `constant_value` (ConstantSchemaOverrideConstantValue, optional) — O valor constante a ser usado - `source`: `dynamic_variable` - `dynamic_variable` (string, required) — O nome da variável dinâmica a ser usada - `source`: `llm` - `prompt` (string, optional) — Substituição do prompt para o LLM. Se não for fornecida, será usada a descrição do esquema original. - `source`: `omit` ### TranslatedString - `value` (string, required) ### UnitTestToolCallParameterEval - `type`: `anything` - `type`: `exact` - `expected_value` (string, required) — O valor exato da string ao qual o parâmetro deve corresponder. - `type`: `llm` - `description` (string, required) — Uma descrição da estratégia de avaliação a ser usada no teste. - `type`: `regex` - `pattern` (string, required) — Um padrão regex para comparar com a resposta do agente. ### ConversationHistoryTranscriptToolCallWebhookDetails - `method` (string, required) - `url` (string, required) - `type` ("webhook", optional) - `headers` (map from string to string, optional) - `path_params` (map from string to string, optional) - `query_params` (map from string to string, optional) - `body` (string, optional) ### DynamicVariableUpdateCommonModel Rastreia uma atualização de variável dinâmica ocorrida durante a execução da ferramenta. - `variable_name` (string, required) - `new_value` (string, required) - `updated_at` (double, required) - `tool_name` (string, required) - `tool_request_id` (string, required) - `old_value` (string, optional) ### ConversationHistoryTranscriptSystemToolResultCommonModelOutputResult - `result_type`: `dummy` - `result_type`: `end_call_success` - `message` (string, optional) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `end_procedure_error` - `message` (string, required) - `status` (enum, required) - Allowed values: `not_found`, `invalid_id` - `procedure_id` (string, optional) - `result_type`: `end_procedure_success` - `procedure_id` (string, required) - `procedure_name` (string, required) - `message` (string, optional, default: ) - `status` ("success", optional) - `result_type`: `knowledge_base_rag_success` - `chunk_count` (integer, optional, default: 0) — Número de trechos relevantes recuperados - `chunks` (list of KnowledgeBaseRagChunkModel, optional) — Trechos recuperados; preenchido apenas no modo rag-result-in-tool-result - `message` (string, optional, default: Referenced knowledge base.) — Status legível para humanos para o LLM sobre os resultados da busca - `status` (enum, optional, default: success) - Allowed values: `success`, `no_documents`, `no_results` - `result_type`: `knowledge_base_success` - `chunk_count` (integer, optional, default: 0) - `message` (string, optional, default: Referenced knowledge base.) - `status` (enum, optional, default: success) - Allowed values: `success`, `no_matching_documents`, `no_results` - `result_type`: `language_detection_success` - `language` (string, optional) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `play_dtmf_error` - `error` (string, required) - `details` (string, optional) - `status` ("error", optional) - `result_type`: `play_dtmf_success` - `dtmf_tones` (string, required) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `skip_turn_success` - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `start_procedure_error` - `message` (string, required) - `status` (enum, required) - Allowed values: `not_found`, `invalid_name`, `already_active` - `procedure_id` (string, optional) - `result_type`: `start_procedure_success` - `procedure_id` (string, required) - `procedure_name` (string, required) - `message` (string, optional, default: Procedure is now started. Follow its instructions from the section of your system prompt.) - `procedure_entry_workflow_node` (string, optional) - `procedure_return_workflow_node` (string, optional) - `status` ("success", optional) - `result_type`: `testing_tool_result` - `reason` (string, optional, default: Skipping tool call in test mode) - `status` ("success", optional) - `result_type`: `transfer_to_agent_error` - `error` (string, required) - `from_agent` (string, required) - `status` ("error", optional) - `result_type`: `transfer_to_agent_success` - `condition` (string, required) - `from_agent` (string, required) - `to_agent` (string, required) - `branch_info` (TransferToAgentToolResultSuccessModelOutputBranchInfo, optional) - `delay_ms` (integer, optional, default: 0) - `enable_transferred_agent_first_message` (boolean, optional, default: false) - `preserve_client_tts_overrides` (boolean, optional, default: false) - `preserve_voice_settings` (boolean, optional, default: false) - `status` ("success", optional) - `to_node` (string, optional) - `transfer_message` (string, optional) - `result_type`: `transfer_to_number_amazon_connect_success` - `client_message` (string, optional) — Mensagem falada para quem ligou antes de a sessão ser devolvida ao Amazon Connect. - `note` (string, optional) — Definido quando o agente repetiu uma opção inválida e usou a única opção configurada. - `reason` (string, optional) — Por que o agente escalonou, conforme enviado ao Amazon Connect com o resultado Escalate. - `status` ("success", optional) - `result_type`: `transfer_to_number_error` - `error` (string, required) - `details` (string, optional) - `status` ("error", optional) - `result_type`: `transfer_to_number_exotel_success` - `transfer_number` (string, required) - `agent_message` (string, optional) - `note` (string, optional) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `transfer_to_number_sip_success` - `transfer_number` (string, required) - `note` (string, optional) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `transfer_to_number_twilio_success` - `agent_message` (string, required) - `conference_name` (string, required) - `transfer_number` (string, required) - `client_message` (string, optional) - `note` (string, optional) - `post_dial_digits` (string, optional) - `reason` (string, optional) - `status` ("success", optional) - `result_type`: `voicemail_detection_success` - `reason` (string, optional) - `status` ("success", optional) - `voicemail_message` (string, optional) ### WorkflowToolResponseModelOutput Um modelo comum para respostas de ferramentas de workflow. - `steps` (list of WorkflowToolResponseModelOutputStepsItem, optional) ### LlmTokensCategoryUsage - `tokens` (integer, optional, default: 0) - `price` (double, optional, default: 0) ### SoftTimeoutConfigOverride - `message` (string, optional) — Mensagem a exibir quando o primeiro tempo limite flexível for atingido durante a espera pela resposta do LLM. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}). - `additional_soft_timeout_messages` (list of string, optional) — Mensagens estáticas extras de preenchimento para os soft timeouts subsequentes na mesma geração de LLM. O primeiro timeout usa `message`. Se houver menos mensagens configuradas que `max_soft_timeouts_per_generation`, a última mensagem configurada será repetida; caso contrário, será usada uma mensagem de preenchimento integrada. ### PromptAgentApiModelOverrideOutput - `prompt` (string, optional) — O prompt do agente - `llm` (enum, optional) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `tool_ids` (list of string, optional) — Uma lista de IDs das ferramentas usadas pelo agente. - `tool_ids_strict` (boolean, optional) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente. - `native_mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente - `knowledge_base` (list of KnowledgeBaseLocator, optional) — Uma lista de bases de conhecimento a serem usadas pelo agente ### SystemToolConfigOutput Uma ferramenta de sistema é usada para chamar um método do sistema no servidor - `name` (string, required) - `params` (SystemToolConfigOutputParams, required) - `type` ("system", optional) — O tipo de ferramenta - `description` (string, optional, default: ) — Descrição de quando a ferramenta deve ser usada e do que ela faz. Deixe em branco para usar a descrição padrão otimizada para o tipo específico de ferramenta. - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. ### CustomLlmApiKey A chave de API para autenticação. Pode ser uma referência a um segredo do workspace \{'secret\_id': '...'} ou uma referência a uma variável de ambiente \{'env\_var\_label': '...'}. ### CustomLlmAuthConnection Conexão de autenticação opcional do workspace. Só há suporte para conexões de autenticação que produzem um token Authorization Bearer; não há suporte para conexões de autenticação Basic, mTLS, cabeçalho personalizado e segredo de URL. ### CustomLlmRequestHeadersValue ### KnowledgeBaseToolInfo - `enabled_strategies` (list of enum, optional) — Estratégias de pesquisa expostas ao modelo. Não pode estar vazio. - Allowed values: `cat`, `keyword`, `semantic`, `ls` ### DynamicVariableAssignment Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas. - `dynamic_variable` (string, required) — O nome da variável dinâmica à qual atribuir o valor extraído - `value_path` (string, required) — Caminho em notação de ponto para extrair o valor da origem, por exemplo, 'user.name' ou 'data.0.id'. - `source` ("response", optional) — A origem da qual extrair o valor. No momento, apenas 'response' é compatível. - `sanitize` (boolean, optional, default: false) — Se for true, o valor desta atribuição será removido da resposta da ferramenta antes de ser enviado ao LLM e à transcrição, mas ainda será processado para atribuição de variável. - `preserve_native_type` (boolean, optional, default: false) — Se for true, valores não escalares (listas, objetos) extraídos da resposta da ferramenta serão armazenados em seu tipo nativo, em vez de serem convertidos em strings JSON. Ative esta opção para usar arrays extraídos diretamente como variáveis dinâmicas de lista. ### DynamicVariablesConfig - `dynamic_variable_placeholders` (map from string to any, optional) — Um dicionário de marcadores de variáveis dinâmicas e seus valores. ### ApiIntegrationWebhookOverrides - `schema_overrides` (map from string to ApiIntegrationWebhookOverridesSchemaOverridesValue, optional) - `response_filter_mode` (enum, optional, default: all) — Controla como as respostas das ferramentas são filtradas antes de ficarem visíveis para o agente. - Allowed values: `all`, `allow`, `hide_all` - `response_filters` (list of string, optional) - `request_headers` (map from string to ApiIntegrationWebhookOverridesRequestHeadersValue, optional) ### ObjectJsonSchemaPropertyOutput - `description` (string, optional, default: ) - `dynamic_variable` (string, optional, default: ) — Quando definido, todo o parâmetro é preenchido com esta variável dinâmica no tempo de execução. Mutuamente exclusivo com description (valor fornecido pelo LLM), constant_value e is_omitted. - `constant_value` (map from string to any, optional) — Quando definido, todo o objeto usa este valor JSON constante no tempo de execução. Mutuamente exclusivo com description (objeto fornecido pelo LLM), dynamic_variable e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable e constant_value. - `type` ("object", optional) - `required` (list of string, optional) - `properties` (map from string to ObjectJsonSchemaPropertyOutputPropertiesValue, optional) - `required_constraints` (RequiredConstraints, optional) — Contêiner para restrições de composição anyOf/allOf aplicadas aos campos obrigatórios. ### SystemToolConfigOutputParams - `system_tool_type`: `end_call` - `system_tool_type`: `end_procedure` - `procedures` (map from string to EndProcedureToolConfigProceduresValue, optional) - `system_tool_type`: `knowledge_base` - `enabled_strategies` (list of enum, optional) - Allowed values: `cat`, `keyword`, `semantic`, `ls` - `system_tool_type`: `knowledge_base_rag` - `system_tool_type`: `language_detection` - `only_at_conversation_start` (boolean, optional, default: false) — Se nenhuma troca de idioma ocorrer nos 2 primeiros turnos do usuário, as tentativas posteriores falharão e a conversa permanecerá no idioma atual. Se o idioma mudar durante esses turnos, mudanças posteriores continuarão disponíveis. Ative para reduzir a possibilidade de trocas incorretas. - `system_tool_type`: `play_keypad_touch_tone` - `suppress_turn_after_dtmf` (boolean, optional, default: false) — Se for true, o agente não gerará mais fala após reproduzir tons DTMF. Isso evita que a fala do agente interfira em sistemas de IVR. - `use_out_of_band_dtmf` (boolean, optional, default: true) — Envie tons DTMF como eventos RTP fora de banda (RFC 4733), em vez de áudio em banda. Só é eficaz para números importados de troncos SIP. - `system_tool_type`: `skip_turn` - `wait_timeout_secs` (double, optional, default: -1) — Segundos de espera após skip_turn antes de o agente gerar uma verificação contextual. O temporizador "Encerrar conversa após silêncio" é pausado durante a espera. -1 desativa a espera: após skip_turn, o agente permanece em silêncio até que o chamador fale, e esse temporizador continua em execução. Aplica-se apenas a conversas por voz. - `system_tool_type`: `start_procedure` - `procedures` (map from string to StartProcedureToolConfigProceduresValue, optional) - `system_tool_type`: `transfer_to_agent` - `transfers` (list of AgentTransferOutput, required) - `system_tool_type`: `transfer_to_number` - `transfers` (list of PhoneNumberTransfer, required) - `enable_client_message` (boolean, optional, default: true) — Se deve reproduzir uma mensagem para o cliente enquanto ele aguarda a transferência. O padrão é true para manter a compatibilidade com versões anteriores. - `system_tool_type`: `voicemail_detection` - `voicemail_message` (string, optional) — Mensagem opcional para deixar na caixa postal quando ela for detectada. Se não for fornecida, a chamada será encerrada imediatamente ao detectar a caixa postal. Oferece suporte a variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{system\_\_call\_duration\_secs}}, \{\{custom\_variable}}). ### WebhookToolApiSchemaConfigOutput - `url` (string, required) — A URL para a qual o webhook será enviado. Pode incluir parâmetros de caminho, por exemplo, [https://example.com/agents/\{agent\_id}](https://example.com/agents/\{agent_id}) - `request_headers` (map from string to WebhookToolApiSchemaConfigOutputRequestHeadersValue, optional) — Cabeçalhos que devem ser incluídos na solicitação - `method` (enum, optional, default: GET) — O método HTTP a usar para o webhook - Allowed values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE` - `path_params_schema` (map from string to LiteralJsonSchemaProperty, optional) — Schema para parâmetros de caminho, se houver. As chaves devem corresponder aos placeholders na URL. - `query_params_schema` (QueryParamsJsonSchemaOutput, optional) — Schema para parâmetros de consulta, se houver. Eles serão adicionados ao final da URL como parâmetros de consulta. Observação: as propriedades em um parâmetro de consulta devem ser todas de tipos literais - `request_body_schema` (ObjectJsonSchemaPropertyOutput, optional) — Schema para os parâmetros do corpo, se houver. Usado para solicitações POST/PATCH/PUT. O schema deve ser um objeto que será enviado como corpo JSON - `response_body_schema` (ObjectJsonSchemaPropertyOutput, optional) — Schema que descreve a estrutura esperada do corpo da resposta. Apenas para documentação; não é exibido ao LLM. - `response_filter` (ResponseFilter, optional) — Filtro opcional de lista de permissões aplicado à resposta antes que o LLM a veja, para que respostas grandes não poluam o contexto. O padrão é a resposta completa. - `content_type` (enum, optional, default: application/json) — Tipo de conteúdo do corpo da solicitação. Aplica-se apenas a solicitações POST/PUT/PATCH. - Allowed values: `application/json`, `application/x-www-form-urlencoded` - `auth_resolved_params` (list of string, optional) — Placeholders de URL resolvidos pela conexão de autenticação (por exemplo, segredos inseridos por UrlSecretAuthConnection), e não por path_params_schema. - `auth_connection` (WebhookToolApiSchemaConfigOutputAuthConnection, optional) — Conexão de autenticação opcional a usar para autenticar neste webhook ### SoftTimeoutConfigOverrideConfig - `message` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo message. - `additional_soft_timeout_messages` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo additional_soft_timeout_messages. ### PromptAgentApiModelOverrideConfig - `prompt` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo prompt. - `llm` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo llm. - `tool_ids` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo tool_ids. - `tool_ids_strict` (boolean, optional, default: false) — Se deve permitir a substituição do campo tool_ids_strict. - `native_mcp_server_ids` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo native_mcp_server_ids. - `knowledge_base` (boolean, optional, default: false) — Indica se deve permitir a substituição do campo knowledge_base. ### ConvAiSecretLocator Usado para referenciar um segredo do armazenamento de segredos do agente. - `secret_id` (string, required) ### ContentThresholdGuardrail - `is_enabled` (boolean, optional, default: false) - `threshold` (ContentThresholdGuardrailThreshold, optional) ### CustomGuardrailConfig Configuração única de guardrail personalizado - `name` (string, required) — Nome voltado ao usuário para esta proteção - `prompt` (string, required) — Instrução que descreve o que bloquear, por exemplo, 'não fale sobre política' - `is_enabled` (boolean, optional, default: false) - `execution_mode` (enum, optional, default: streaming) - Allowed values: `streaming`, `blocking` - `model` (enum, optional, default: gemini-3.1-flash-lite) — Modelo de LLM a usar na avaliação de guardrails personalizados - Allowed values: `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `claude-haiku-4-5`, `claude-sonnet-4-6`, `gpt-5.4-nano`, `gpt-5.4-mini` - `history_message_count` (integer, optional, default: 0) — Quanto do histórico recente o guardrail vê antes da resposta que avalia, contado em mensagens do usuário (as respostas do agente entre elas também são incluídas). O guardrail sempre recebe uma única transcrição \ que termina na resposta avaliada, marcada como 'AGENT \[current reply]:'. 0 (padrão) não adiciona histórico anterior, apenas essa linha; 1 adiciona a partir da mensagem mais recente do usuário. - `trigger_action` (CustomGuardrailConfigTriggerAction, optional) - `evaluate_full_response_only` (boolean, optional, default: false) — Avalie uma vez em relação à resposta completa sem TTS, em vez de respostas parciais cumulativas. Requer o modo de bloqueio. ### LlmLiteralJsonSchemaProperty - `type` (LlmLiteralJsonSchemaPropertyType, required) - `description` (string, required) - `enum` (list of string, optional) — List of allowed string values for string type parameters ### AstNumberNodeInputValue Valor deste literal. ### SoftTimeoutConfigWorkflowOverride - `timeout_seconds` (double, optional) — Tempo em segundos antes de exibir a mensagem predefinida enquanto aguarda a resposta do LLM. Defina como -1 para desativar. - `message` (string, optional) — Mensagem a exibir quando o primeiro tempo limite flexível for atingido durante a espera pela resposta do LLM. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}). - `additional_soft_timeout_messages` (list of string, optional) — Mensagens estáticas extras de preenchimento para os soft timeouts subsequentes na mesma geração de LLM. O primeiro timeout usa `message`. Se houver menos mensagens configuradas que `max_soft_timeouts_per_generation`, a última mensagem configurada será repetida; caso contrário, será usada uma mensagem de preenchimento integrada. - `use_llm_generated_message` (boolean, optional) — Se ativado, a mensagem de timeout suave será gerada dinamicamente em vez de usar a mensagem estática. - `randomize_fillers` (boolean, optional) — Se ativado, embaralha uma vez a ordem das mensagens estáticas de timeout suave no início de cada turno. Aplica-se apenas quando use_llm_generated_message é false. - `max_soft_timeouts_per_generation` (integer, optional) — Número máximo de mensagens de preenchimento durante a espera por uma única resposta do LLM. É acionado a cada timeout_seconds até que o LLM transmita conteúdo ou esse limite seja atingido. - `llm_generated_message_prompt_override` (string, optional) — Prompt personalizado para gerar a mensagem de preenchimento de tempo limite flexível quando use\_llm\_generated\_message estiver ativado. O contexto recente da conversa é fornecido como uma mensagem de usuário separada. Se não for definido, o prompt padrão será usado. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}). - `disable_until_first_user_message` (boolean, optional) — Quando true, os preenchimentos de timeout flexível são suprimidos até que a conversa tenha pelo menos uma mensagem real do usuário. Isso evita preenchimentos durante o turno de abertura do agente (por exemplo, workflow generate-immediately ou chamadas de ferramenta antes de o usuário falar). ### EffectsSpecInput 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) — 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) — 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) — 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. ### FileInputConfigWorkflowOverride - `enabled` (boolean, optional) — 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) — 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) — 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. ### BackgroundSoundConfigWorkflowOverride - `source_type` ("preset", optional) — O tipo de fonte de som de fundo. - `source_id` (enum, optional) — Identificador da fonte sonora. - Allowed values: `office2`, `office1`, `restaurant`, `city`, `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `volume` (double, optional) — Nível de volume do som de fundo (0,01 a 1,0). - `crossfade_loop` (boolean, optional) — Aplique um crossfade no limite do loop para evitar estalos audíveis quando o som se repetir. ### ConversationConfigClientOverrideInput - `asr` (AsrConversationalConfigOverride, optional) — Configuração para transcrição conversacional - `turn` (TurnConfigOverride, optional) — Configuração para detecção de turnos - `tts` (TtsConversationalConfigOverride, optional) — Configuração para Text to Speech conversacional - `conversation` (ConversationConfigOverride, optional) — Configuração para eventos de conversa - `agent` (AgentConfigOverrideInput, optional) — Configuração específica do agente ### DynamicVariablesConfigWorkflowOverride - `dynamic_variable_placeholders` (map from string to any, optional) — Um dicionário de marcadores de variáveis dinâmicas e seus valores. ### PromptAgentApiModelWorkflowOverrideInput - `prompt` (string, optional) — O prompt do agente - `llm` (enum, optional) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `reasoning_effort` (enum, optional) — Esforço de raciocínio do modelo. Disponível apenas para alguns modelos. - Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max` - `thinking_budget` (integer, optional) — Número máximo de tokens usados para raciocínio. Use 0 para desativar, se houver suporte do modelo. - `enable_reasoning_summary` (boolean, optional) — Ative resumos de raciocínio do modelo. Quando desativado, não solicitamos resumos ao provedor, quando possível, para obter um TTFB mais rápido. Não é compatível com ZRM. - `temperature` (double, optional) — A temperatura para o LLM. O padrão é 0. Defina como null para omitir totalmente o parâmetro da solicitação ao LLM, o que é útil para LLMs personalizados que rejeitam o campo de temperatura. - `max_tokens` (integer, optional) — Se for maior que 0, número máximo de tokens que o LLM pode prever - `tool_ids` (list of string, optional) — Uma lista de IDs das ferramentas usadas pelo agente. - `tool_ids_strict` (boolean, optional) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente. - `built_in_tools` (BuiltInToolsWorkflowOverrideInput, optional) — Ferramentas de sistema integradas a serem usadas pelo agente - `enable_parallel_tool_calls` (boolean, optional) — Ative chamadas paralelas de ferramentas. Quando ativado, o agente pode executar várias ferramentas em paralelo em um único turno. Não é compatível com todos os modelos. - `mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP a serem usados pelo agente - `native_mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente - `knowledge_base` (list of KnowledgeBaseLocator, optional) — Uma lista de bases de conhecimento a serem usadas pelo agente - `custom_llm` (CustomLlm, optional) — Definição de um LLM personalizado se o campo LLM estiver definido como 'CUSTOM_LLM' - `ignore_default_personality` (boolean, optional) — Se deve remover as linhas de personalidade padrão do prompt do sistema - `rag` (RagConfigWorkflowOverrideInput, optional) — Configuração para RAG - `timezone` (string, optional) — Fuso horário para exibir a hora atual no prompt do sistema. Se definido, a hora atual será incluída no prompt do sistema usando esse fuso horário. Deve ser um nome de fuso horário válido (por exemplo, 'America/New_York', 'Europe/London', 'UTC'). Recomendado para respostas precisas que consideram o horário; sem isso, o agente não tem conhecimento da data/hora atual, a menos que você a forneça por meio de variáveis dinâmicas ou ferramentas, o que pode levar a referências de tempo incorretas ou alucinadas. - `backup_llm_config` (PromptAgentApiModelWorkflowOverrideInputBackupLlmConfig, optional) — Configuração da cascata de LLMs de backup. Pode ser desativada, usar os padrões do sistema ou especificar uma ordem personalizada. - `cascade_timeout_seconds` (double, optional) — Tempo em segundos antes de alternar para o LLM de backup. Deve estar entre 2 e 15 segundos. - `tools` (list of PromptAgentApiModelWorkflowOverrideInputToolsItem, optional) — Uma lista de ferramentas que o agente pode usar durante a conversa; use tool_ids em vez disso ### ConstantSchemaOverrideConstantValue O valor constante a ser usado ### KnowledgeBaseRagChunkModel - `chunk_id` (string, required) - `document_id` (string, required) - `content` (string, required) ### TransferToAgentToolResultSuccessModelOutputBranchInfo - `branch_reason`: `configured` - `branch_id` (string, required) - `branch_reason`: `defaulting_to_main` - `branch_id` (string, required) - `branch_reason`: `traffic_split` - `branch_id` (string, required) - `traffic_percentage` (double, required) ### WorkflowToolResponseModelOutputStepsItem - `type`: `edge` - `edge_id` (string, required) - `step_latency_secs` (double, required) - `target_node_id` (string, required) - `type`: `max_iterations_exceeded` - `max_iterations` (integer, required) - `step_latency_secs` (double, required) - `type`: `nested_tools` - `is_successful` (boolean, required) - `node_id` (string, required) - `requests` (list of ConversationHistoryTranscriptToolCallCommonModelOutput, required) - `results` (list of WorkflowToolNestedToolsStepModelOutputResultsItem, required) - `step_latency_secs` (double, required) ### ConvAiEnvVarLocator Usado para referenciar uma variável de ambiente pelo rótulo. - `env_var_label` (string, required) ### AuthConnectionLocator Usado para referenciar uma conexão de autenticação do armazenamento de conexões de autenticação do espaço de trabalho. - `auth_connection_id` (string, required) ### EnvironmentAuthConnectionLocator Referencia uma variável de ambiente do tipo 'auth_connection' pelo rótulo. Em tempo de execução, é resolvida para a conexão de autenticação do ambiente atual, recorrendo ao ambiente padrão. - `env_var_label` (string, required) ### ConvAiDynamicVariable Usado para referenciar uma variável dinâmica. - `variable_name` (string, required) ### ApiIntegrationWebhookOverridesSchemaOverridesValue - `source`: `constant` - `constant_value` (ConstantSchemaOverrideConstantValue, optional) — O valor constante a ser usado - `source`: `dynamic_variable` - `dynamic_variable` (string, required) — O nome da variável dinâmica a ser usada - `source`: `llm` - `prompt` (string, optional) — Substituição do prompt para o LLM. Se não for fornecida, será usada a descrição do esquema original. - `source`: `omit` ### ApiIntegrationWebhookOverridesRequestHeadersValue ### ObjectJsonSchemaPropertyOutputPropertiesValue ### RequiredConstraints Contêiner para restrições de composição anyOf/allOf aplicadas aos campos obrigatórios. - `any_of` (list of RequiredConstraint, optional) - `all_of` (list of RequiredConstraint, optional) ### EndProcedureToolConfigProceduresValue ### StartProcedureToolConfigProceduresValue ### AgentTransferOutput - `condition` (string, required) - `agent_id` (string, optional) - `branch_id` (string, optional) - `node_id` (string, optional) - `delay_ms` (integer, optional, default: 0) - `transfer_message` (string, optional) - `enable_transferred_agent_first_message` (boolean, optional, default: false) - `is_workflow_node_transfer` (boolean, optional, default: false) - `preserve_client_tts_overrides` (boolean, optional, default: false) — Define se as substituições do cliente de TTS devem ser mantidas no agente transferido. - `preserve_voice_settings` (boolean, optional, default: false) — Define se a voz base, o modelo TTS e as configurações de voz devem ser transferidos para o agente transferido. ### PhoneNumberTransfer - `transfer_destination` (PhoneNumberTransferTransferDestination, required) - `condition` (string, required) - `custom_sip_headers` (list of PhoneNumberTransferCustomSipHeadersItem, optional) — Cabeçalhos SIP personalizados a serem incluídos ao transferir a chamada. Cada cabeçalho pode ser um valor estático ou uma referência a variável dinâmica. - `transfer_type` (enum, optional, default: conference) - Allowed values: `blind`, `conference`, `sip_refer` - `sip_refer_play_dialtone` (boolean, optional, default: true) — Quando True, um tom de chamada é reproduzido na perna original da chamada enquanto uma transferência SIP REFER é concluída. O tom é transmitido por RTP ao par SIP que executa o REFER, portanto desative esta opção se o sistema receptor (por exemplo, um SBC ou central de atendimento) não deve ouvi-lo. Quando desativada, a pessoa que ligou ouve silêncio até a transferência ser concluída. Apenas para transferências SIP REFER. - `uui` (UuiTransferConfig, optional) — Informações de Usuário para Usuário (RFC 7433) a serem anexadas a transferências SIP REFER. Transporta o contexto da chamada, como identificadores de CRM ou motivo de escalonamento, durante a transferência. - `post_dial_digits` (PhoneNumberTransferPostDialDigits, optional) — Dígitos DTMF a enviar após a conexão da chamada, por exemplo, 'ww1234' para ramal. Pode ser um valor estático ou uma referência de variável dinâmica. Use 'w' para uma pausa de 0,5 s. Compatível apenas com transferências do Twilio. - `phone_number` (string, optional, deprecated) ### WebhookToolApiSchemaConfigOutputRequestHeadersValue ### LiteralJsonSchemaProperty Propriedade de schema para tipos JSON literais. IMPORTANTE: apenas UM dos seguintes campos pode ser definido: description (o LLM fornece o valor), dynamic_variable (valor de uma variável), is_system_provided (o sistema fornece o valor), constant_value (valor fixo) ou is_omitted (o parâmetro é omitido). Eles são mutuamente exclusivos. - `type` (LiteralJsonSchemaPropertyType, required) - `description` (string, optional, default: ) — A descrição da propriedade. Quando definida, o LLM fornecerá o valor com base nesta descrição. Mutuamente exclusiva com dynamic_variable, is_system_provided, constant_value e is_omitted. - `enum` (list of string, optional) — List of allowed string values for string type parameters - `is_system_provided` (boolean, optional, default: false) — Se for true, o valor será preenchido pelo sistema em tempo de execução. Usado por ferramentas de Webhook de integração de API para criação de templates. Mutuamente exclusivo com description, dynamic_variable, constant_value e is_omitted. - `dynamic_variable` (string, optional, default: ) — O nome da variável dinâmica a ser usada para o valor desta propriedade. Mutuamente exclusivo com description, is_system_provided, constant_value e is_omitted. - `allowed_values` (AllowedValues, optional) — Proteção de rejeição no servidor para um valor fornecido por um LLM: o runtime rejeita qualquer valor fora do conjunto permitido nomeado por este objeto, e o conjunto não é apresentado ao LLM como um enum. Compatível apenas quando a origem do valor é `description`; combiná-la com dynamic_variable, is_system_provided, constant_value ou is_omitted é rejeitado. - `constant_value` (LiteralJsonSchemaPropertyConstantValue, optional) — Um valor constante para usar nesta propriedade. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e constant_value. - `allowed_values_dynamic_variable` (string, optional, default: , deprecated) — DESCONTINUADO: use `allowed_values`. Quando definido, o LLM fornece o valor, mas o tempo de execução rejeita qualquer valor que não esteja na lista mantida por esta variável dinâmica (deve ser um array JSON, como ["ws_alpha", "ws_beta"]). Use para permitir que o LLM escolha de um conjunto verificado pelo servidor (por exemplo, os IDs aos quais o usuário atual tem permissão de acesso). Exige descrição; mutuamente exclusivo com dynamic_variable, is_system_provided, constant_value e is_omitted. ### QueryParamsJsonSchemaOutput - `properties` (map from string to LiteralJsonSchemaProperty, required) - `required` (list of string, optional) ### ResponseFilter Configuração para filtrar respostas de ferramentas antes que fiquem visíveis para o agente. - `mode` (enum, optional, default: all) — Controla como as respostas das ferramentas são filtradas. 'all' retorna a resposta inteira, 'allow' retorna apenas os caminhos especificados e 'hide_all' oculta a resposta inteira. - Allowed values: `all`, `allow`, `hide_all` - `filters` (list of string, optional) — Caminhos em notação de ponto a incluir quando o modo for 'allow', por exemplo, ['ticket.id', 'ticket.status']. - `content_type` ("application/json", optional) — Tipo de conteúdo para filtragem de respostas. Apenas respostas 'application/json' são filtradas. ### WebhookToolApiSchemaConfigOutputAuthConnection Conexão de autenticação opcional a usar para autenticar neste webhook ### ContentThresholdGuardrailThreshold ### CustomGuardrailConfigTriggerAction - `type`: `end_call` - `type`: `retry` - `feedback` (string, optional, default: Your response was blocked by a guardrail that blocks content that matches this condition/category: '{{trigger_reason}}' During your next turn you must tell the user "I'm sorry but I can't answer that question, would you like to know something else?".) — Feedback personalizado a ser inserido no agente ao tentar novamente após o acionamento de uma proteção. ### LlmLiteralJsonSchemaPropertyType ### AgentConfigOverrideInput - `first_message` (string, optional) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa. - `language` (string, optional) — Idioma do agente — usado para ASR e TTS - `max_conversation_duration_message` (string, optional) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida. - `prompt` (PromptAgentApiModelOverrideInput, optional) — O prompt do agente ### BuiltInToolsWorkflowOverrideInput - `transfer_to_agent` (SystemToolConfigInput, optional) — A ferramenta de transferência para agente - `end_call` (SystemToolConfigInput, optional) — A ferramenta de encerramento da chamada - `language_detection` (SystemToolConfigInput, optional) — A ferramenta de detecção de idioma - `transfer_to_number` (SystemToolConfigInput, optional) — A ferramenta de transferência para número - `skip_turn` (SystemToolConfigInput, optional) — A ferramenta para pular turno - `play_keypad_touch_tone` (SystemToolConfigInput, optional) — A ferramenta de reprodução DTMF - `voicemail_detection` (SystemToolConfigInput, optional) — A ferramenta de detecção de caixa postal ### RagConfigWorkflowOverrideInput - `enabled` (boolean, optional) - `embedding_model` (enum, optional, default: e5_mistral_7b_instruct) - Allowed values: `e5_mistral_7b_instruct`, `multilingual_e5_large_instruct` - `max_vector_distance` (double, optional) — Distância vetorial máxima dos trechos recuperados. - `max_documents_length` (integer, optional) — Comprimento total máximo dos trechos de documentos recuperados do RAG. - `max_retrieved_rag_chunks_count` (integer, optional) — Número máximo de trechos de documentos RAG a recuperar inicialmente do armazenamento vetorial. Eles são então filtrados ainda mais pela distância vetorial e pelo comprimento total. - `num_candidates` (integer, optional) — Número de candidatos avaliados na busca vetorial ANN. Um número maior significa melhores resultados, mas maior latência. O valor mínimo recomendado é 100. Se desativado, o valor padrão será usado. - `query_rewrite_prompt_override` (string, optional) — Prompt personalizado para reescrever consultas do usuário antes da recuperação RAG. O histórico da conversa será anexado automaticamente ao final. Se não for definido, o prompt padrão será usado. - `knowledge_base_tool_info` (KnowledgeBaseToolInfo, optional) — Quando definido, o agente usa a ferramenta knowledge_base em vez da ferramenta legada knowledge_base_rag. None significa que o agente não aderiu. ### PromptAgentApiModelWorkflowOverrideInputBackupLlmConfig Configuração da cascata de LLMs de backup. Pode ser desativada, usar os padrões do sistema ou especificar uma ordem personalizada. ### PromptAgentApiModelWorkflowOverrideInputToolsItem O tipo de ferramenta - `type`: `api_integration_webhook` - `api_integration_connection_id` (string, required) - `api_integration_id` (string, required) - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `name` (string, required) - `api_schema_overrides` (ApiIntegrationWebhookOverrides, optional) — Substituições do usuário aplicadas sobre o api_schema base - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `dynamic_variables` (DynamicVariablesConfig, optional) — Configuração para variáveis dinâmicas - `execution_mode` (enum, optional, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. Deve estar entre 5 e 300 segundos, inclusive. - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `tool_version` (string, optional, default: 1.0.0) — A versão da ferramenta de integração da API - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `type`: `client` - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `name` (string, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `dynamic_variables` (DynamicVariablesConfig, optional) — Configuração para variáveis dinâmicas - `execution_mode` (enum, optional, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `expects_response` (boolean, optional, default: false) — Se for true, a chamada desta ferramenta deverá bloquear a conversa até que o cliente responda, e essa resposta será passada ao LLM. Se for false, continuaremos a conversa sem esperar a resposta do cliente. Isso é útil para mostrar conteúdo a um usuário sem bloquear a conversa. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `parameters` (ObjectJsonSchemaPropertyInput, optional) — Schema para quaisquer parâmetros a serem enviados ao cliente - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, de espera pela conclusão da chamada da ferramenta. Deve ser entre 1 e 120 segundos (inclusive) ou -1 para aguardar indefinidamente a resposta do cliente (requer expects_response). - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `type`: `mcp` - `value` (any, required) - `type`: `smb` - `value` (any, required) - `type`: `system` - `name` (string, required) - `params` (SystemToolConfigInputParams, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `description` (string, optional, default: ) — Descrição de quando a ferramenta deve ser usada e do que ela faz. Deixe em branco para usar a descrição padrão otimizada para o tipo específico de ferramenta. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. - `type`: `webhook` - `api_schema` (WebhookToolApiSchemaConfigInput, required) — O esquema do webhook de saída, incluindo parâmetros e especificação de URL - `description` (string, required) — Descrição de quando a ferramenta deve ser usada e do que ela faz. - `name` (string, required) - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `dynamic_variables` (DynamicVariablesConfig, optional) — Configuração para variáveis dinâmicas - `execution_mode` (enum, optional, default: immediate) — Determina quando e como a ferramenta é executada: 'immediate' executa a ferramenta imediatamente quando solicitada pelo LLM; 'post_tool_speech' aguarda o agente terminar de falar antes de executar; e 'async' executa a ferramenta em segundo plano, sem bloquear — ideal para operações demoradas. - Allowed values: `immediate`, `post_tool_speech`, `async` - `follow_redirects` (boolean, optional, default: false) — Se deve seguir um redirecionamento do endpoint e retornar a resposta final. Um redirecionamento é seguido como um GET sem o corpo da solicitação; nenhuma configuração desta ferramenta (cabeçalhos, autenticação, certificado de cliente) é enviada ao destino do redirecionamento. Tanto o endpoint quanto o destino do redirecionamento devem usar HTTPS. Não é compatível com ferramentas de integração de API. - `follow_redirects_allowed_domains` (list of string, optional) — Domínios para os quais um redirecionamento pode apontar, por exemplo, 'test.example.com'. Obrigatório ao seguir redirecionamentos; um destino fora da lista será recusado. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. Deve estar entre 5 e 300 segundos, inclusive. - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. ### WorkflowToolNestedToolsStepModelOutputResultsItem ### ArrayJsonSchemaPropertyOutput - `description` (string, optional, default: ) - `dynamic_variable` (string, optional, default: ) — Quando definido, todo o parâmetro é preenchido com esta variável dinâmica no tempo de execução. Mutuamente exclusivo com description (valor fornecido pelo LLM), constant_value e is_omitted. - `constant_value` (list of any, optional) — Quando definido, todo o array usa este valor constante no tempo de execução. Mutuamente exclusivo com description (array fornecido pelo LLM), dynamic_variable e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable e constant_value. - `type` ("array", optional) - `items` (ArrayJsonSchemaPropertyOutputItems, optional) — Schema para elementos de array. ### RequiredConstraint Um conjunto de campos que devem estar todos presentes para atender a esta restrição. - `required` (list of string, required) ### ProcedureVersionRef - `procedure_id` (string, required) — ID do procedimento - `version_id` (string, required) — ID da versão do procedimento. ### ProcedureDraftRef - `procedure_id` (string, required) — ID do procedimento - `version_id` (any, optional) ### PhoneNumberTransferTransferDestination - `type`: `phone` - `phone_number` (string, required) - `type`: `phone_dynamic_variable` - `phone_number` (string, required) - `type`: `sip_uri` - `sip_uri` (string, required) - `type`: `sip_uri_dynamic_variable` - `sip_uri` (string, required) ### PhoneNumberTransferCustomSipHeadersItem - `type`: `dynamic` - `key` (string, required) — O nome do cabeçalho SIP (por exemplo, 'X-Customer-ID') - `value` (string, required) — O nome da variável dinâmica a ser resolvida - `type`: `static` - `key` (string, required) — O nome do cabeçalho SIP (por exemplo, 'X-Customer-ID') - `value` (string, required) — O valor do cabeçalho ### PhoneNumberTransferPostDialDigits - `type`: `dynamic` - `value` (string, required) — O nome da variável dinâmica a ser resolvida - `type`: `static` - `value` (string, required) — Dígitos DTMF a enviar após a conexão da chamada, por exemplo, 'ww1234' para ramal ### LiteralJsonSchemaPropertyType ### LiteralJsonSchemaPropertyConstantValue Um valor constante para usar nesta propriedade. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e is_omitted. ### PromptAgentApiModelOverrideInput - `prompt` (string, optional) — O prompt do agente - `llm` (enum, optional) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados. - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `tool_ids` (list of string, optional) — Uma lista de IDs das ferramentas usadas pelo agente. - `tool_ids_strict` (boolean, optional) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente. - `native_mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente - `knowledge_base` (list of KnowledgeBaseLocator, optional) — Uma lista de bases de conhecimento a serem usadas pelo agente ### SystemToolConfigInput Uma ferramenta de sistema é usada para chamar um método do sistema no servidor - `name` (string, required) - `params` (SystemToolConfigInputParams, required) - `type` ("system", optional) — O tipo de ferramenta - `description` (string, optional, default: ) — Descrição de quando a ferramenta deve ser usada e do que ela faz. Deixe em branco para usar a descrição padrão otimizada para o tipo específico de ferramenta. - `response_timeout_secs` (integer, optional, default: 20) — O tempo máximo, em segundos, para aguardar a conclusão da chamada de ferramenta. - `interruption_mode` (enum, optional, default: allow) — Controla se o usuário pode interromper o agente durante esta chamada de ferramenta. 'allow' (padrão) permite que o usuário interrompa a qualquer momento, 'disable_during_tool' suprime interrupções apenas enquanto a ferramenta está em execução e 'disable_during_tool_and_turn' suprime interrupções enquanto a ferramenta é executada e durante a resposta do agente que a segue. - Allowed values: `allow`, `disable_during_tool`, `disable_during_tool_and_turn` - `pre_tool_speech` (enum, optional, default: auto) — Controla se o agente fala antes de esta ferramenta ser chamada. 'auto' (padrão) decide com base na latência recente da ferramenta, 'force' sempre faz o agente falar e 'off' desativa totalmente esse comportamento, independentemente da latência. - Allowed values: `auto`, `force`, `off` - `assignments` (list of DynamicVariableAssignment, optional) — Configuração para extrair valores das respostas de ferramentas e atribuí-los a variáveis dinâmicas - `tool_call_sound` (enum, optional) — Tipo de som predefinido para chamadas de ferramenta, reproduzido durante a execução da ferramenta. Se não for especificado, nenhum som de chamada de ferramenta será reproduzido. - Allowed values: `typing`, `elevator1`, `elevator2`, `elevator3`, `elevator4` - `tool_call_sound_behavior` (enum, optional, default: auto) — Determina quando o som de chamada da ferramenta deve tocar. 'auto' toca apenas quando há fala antes da ferramenta; 'always' toca em todas as chamadas de ferramenta. - Allowed values: `auto`, `always` - `tool_error_handling_mode` (enum, optional, default: auto) — Controla como os erros das ferramentas são processados antes de serem compartilhados com o agente. 'auto' determina o tratamento com base no tipo de ferramenta (resumido para integrações nativas, oculto para as demais), 'summarized' envia um resumo gerado por LLM, 'passthrough' envia o erro bruto e 'hide' não compartilha o erro com o agente. - Allowed values: `auto`, `summarized`, `passthrough`, `hide` - `disable_interruptions` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `interruption_mode`. Se for true, o usuário não poderá interromper o agente enquanto esta ferramenta estiver em execução. - `force_pre_tool_speech` (boolean, optional, default: false, deprecated) — DESCONTINUADO: use `pre_tool_speech`. Se for true, o agente falará antes da chamada da ferramenta. ### BackupLlmDefault - `preference` ("default", optional) ### BackupLlmDisabled - `preference` ("disabled", optional) ### BackupLlmOverride - `order` (list of enum, required) - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-haiku-5-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `nemotron-35-super-vl-nvfp4`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b` - `preference` ("override", optional) ### ObjectJsonSchemaPropertyInput - `property_kind` (enum, optional, default: object) - Allowed values: `array`, `object` - `description` (string, optional, default: ) - `dynamic_variable` (string, optional, default: ) — Quando definido, todo o parâmetro é preenchido com esta variável dinâmica no tempo de execução. Mutuamente exclusivo com description (valor fornecido pelo LLM), constant_value e is_omitted. - `constant_value` (map from string to any, optional) — Quando definido, todo o objeto usa este valor JSON constante no tempo de execução. Mutuamente exclusivo com description (objeto fornecido pelo LLM), dynamic_variable e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable e constant_value. - `type` ("object", optional) - `required` (list of string, optional) - `properties` (map from string to ObjectJsonSchemaPropertyInputPropertiesValue, optional) - `required_constraints` (RequiredConstraints, optional) — Contêiner para restrições de composição anyOf/allOf aplicadas aos campos obrigatórios. ### SystemToolConfigInputParams - `system_tool_type`: `end_call` - `system_tool_type`: `end_procedure` - `procedures` (map from string to EndProcedureToolConfigProceduresValue, optional) - `system_tool_type`: `knowledge_base` - `enabled_strategies` (list of enum, optional) - Allowed values: `cat`, `keyword`, `semantic`, `ls` - `system_tool_type`: `knowledge_base_rag` - `system_tool_type`: `language_detection` - `only_at_conversation_start` (boolean, optional, default: false) — Se nenhuma troca de idioma ocorrer nos 2 primeiros turnos do usuário, as tentativas posteriores falharão e a conversa permanecerá no idioma atual. Se o idioma mudar durante esses turnos, mudanças posteriores continuarão disponíveis. Ative para reduzir a possibilidade de trocas incorretas. - `system_tool_type`: `play_keypad_touch_tone` - `suppress_turn_after_dtmf` (boolean, optional, default: false) — Se for true, o agente não gerará mais fala após reproduzir tons DTMF. Isso evita que a fala do agente interfira em sistemas de IVR. - `use_out_of_band_dtmf` (boolean, optional, default: true) — Envie tons DTMF como eventos RTP fora de banda (RFC 4733), em vez de áudio em banda. Só é eficaz para números importados de troncos SIP. - `system_tool_type`: `skip_turn` - `wait_timeout_secs` (double, optional, default: -1) — Segundos de espera após skip_turn antes de o agente gerar uma verificação contextual. O temporizador "Encerrar conversa após silêncio" é pausado durante a espera. -1 desativa a espera: após skip_turn, o agente permanece em silêncio até que o chamador fale, e esse temporizador continua em execução. Aplica-se apenas a conversas por voz. - `system_tool_type`: `start_procedure` - `procedures` (map from string to StartProcedureToolConfigProceduresValue, optional) - `system_tool_type`: `transfer_to_agent` - `transfers` (list of AgentTransferInput, required) - `system_tool_type`: `transfer_to_number` - `transfers` (list of PhoneNumberTransfer, required) - `enable_client_message` (boolean, optional, default: true) — Se deve reproduzir uma mensagem para o cliente enquanto ele aguarda a transferência. O padrão é true para manter a compatibilidade com versões anteriores. - `system_tool_type`: `voicemail_detection` - `voicemail_message` (string, optional) — Mensagem opcional para deixar na caixa postal quando ela for detectada. Se não for fornecida, a chamada será encerrada imediatamente ao detectar a caixa postal. Oferece suporte a variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{system\_\_call\_duration\_secs}}, \{\{custom\_variable}}). ### WebhookToolApiSchemaConfigInput - `url` (string, required) — A URL para a qual o webhook será enviado. Pode incluir parâmetros de caminho, por exemplo, [https://example.com/agents/\{agent\_id}](https://example.com/agents/\{agent_id}) - `request_headers` (map from string to WebhookToolApiSchemaConfigInputRequestHeadersValue, optional) — Cabeçalhos que devem ser incluídos na solicitação - `method` (enum, optional, default: GET) — O método HTTP a usar para o webhook - Allowed values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE` - `path_params_schema` (map from string to LiteralJsonSchemaProperty, optional) — Schema para parâmetros de caminho, se houver. As chaves devem corresponder aos placeholders na URL. - `query_params_schema` (QueryParamsJsonSchemaInput, optional) — Schema para parâmetros de consulta, se houver. Eles serão adicionados ao final da URL como parâmetros de consulta. Observação: as propriedades em um parâmetro de consulta devem ser todas de tipos literais - `request_body_schema` (ObjectJsonSchemaPropertyInput, optional) — Schema para os parâmetros do corpo, se houver. Usado para solicitações POST/PATCH/PUT. O schema deve ser um objeto que será enviado como corpo JSON - `response_body_schema` (ObjectJsonSchemaPropertyInput, optional) — Schema que descreve a estrutura esperada do corpo da resposta. Apenas para documentação; não é exibido ao LLM. - `response_filter` (ResponseFilter, optional) — Filtro opcional de lista de permissões aplicado à resposta antes que o LLM a veja, para que respostas grandes não poluam o contexto. O padrão é a resposta completa. - `content_type` (enum, optional, default: application/json) — Tipo de conteúdo do corpo da solicitação. Aplica-se apenas a solicitações POST/PUT/PATCH. - Allowed values: `application/json`, `application/x-www-form-urlencoded` - `auth_resolved_params` (list of string, optional) — Placeholders de URL resolvidos pela conexão de autenticação (por exemplo, segredos inseridos por UrlSecretAuthConnection), e não por path_params_schema. - `auth_connection` (WebhookToolApiSchemaConfigInputAuthConnection, optional) — Conexão de autenticação opcional a usar para autenticar neste webhook ### ArrayJsonSchemaPropertyOutputItems Schema para elementos de array. ### ObjectJsonSchemaPropertyInputPropertiesValue ### AgentTransferInput - `condition` (string, required) - `agent_id` (string, optional) - `branch_id` (string, optional) - `node_id` (string, optional) - `delay_ms` (integer, optional, default: 0) - `transfer_message` (string, optional) - `enable_transferred_agent_first_message` (boolean, optional, default: false) - `is_workflow_node_transfer` (boolean, optional, default: false) - `preserve_client_tts_overrides` (boolean, optional, default: false) — Define se as substituições do cliente de TTS devem ser mantidas no agente transferido. - `preserve_voice_settings` (boolean, optional, default: false) — Define se a voz base, o modelo TTS e as configurações de voz devem ser transferidos para o agente transferido. ### WebhookToolApiSchemaConfigInputRequestHeadersValue ### QueryParamsJsonSchemaInput - `properties` (map from string to LiteralJsonSchemaProperty, required) - `required` (list of string, optional) ### WebhookToolApiSchemaConfigInputAuthConnection Conexão de autenticação opcional a usar para autenticar neste webhook ### ArrayJsonSchemaPropertyInput - `property_kind` (enum, optional, default: array) - Allowed values: `array`, `object` - `description` (string, optional, default: ) - `dynamic_variable` (string, optional, default: ) — Quando definido, todo o parâmetro é preenchido com esta variável dinâmica no tempo de execução. Mutuamente exclusivo com description (valor fornecido pelo LLM), constant_value e is_omitted. - `constant_value` (list of any, optional) — Quando definido, todo o array usa este valor constante no tempo de execução. Mutuamente exclusivo com description (array fornecido pelo LLM), dynamic_variable e is_omitted. - `is_omitted` (boolean, optional, default: false) — Se for true, este parâmetro será completamente omitido da solicitação. Válido somente para parâmetros opcionais. Mutuamente exclusivo com description, dynamic_variable e constant_value. - `type` ("array", optional) - `items` (ArrayJsonSchemaPropertyInputItems, optional) — Schema para elementos de array. ### ArrayJsonSchemaPropertyInputItems Schema para elementos de array. ## Examples **Request** ```json { "tests": [ { "test_id": "test_id" } ] } ``` **Response** ```json { "id": "id", "test_runs": [ { "test_run_id": "test_run_id", "test_invocation_id": "test_invocation_id", "agent_id": "agent_id", "status": "pending", "test_id": "test_id", "test_info": { "type": "llm" }, "branch_id": "branch_id", "version_id": "version_id", "ran_against_draft": true, "workflow_node_id": "workflow_node_id", "agent_responses": [ { "role": "user", "time_in_call_secs": 1 } ], "test_name": "test_name", "condition_result": { "result": "success" }, "last_updated_at_unix": 1, "metadata": { "workspace_id": "workspace_id", "test_name": "test_name", "ran_by_user_email": "ran_by_user_email" }, "root_folder_id": "root_folder_id", "root_folder_name": "root_folder_name", "environment": "environment", "credits_used": 1 } ], "agent_id": "agent_id", "branch_id": "branch_id", "version_id": "version_id", "ran_against_draft": true, "created_at": 1, "folder_id": "folder_id", "repeat_count": 1, "cancelled": true, "bucketing_status": "pending", "result_groups": [ { "test_id": "test_id", "test_name": "test_name", "buckets": [ { "test_run_ids": [ "test_run_ids" ], "title": "title", "reason": "reason", "status": "pending" } ], "workflow_node_id": "workflow_node_id" } ] } ``` **SDK Code** ```python import requests url = "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests" payload = { "tests": [{ "test_id": "test_id" }] } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"tests":[{"test_id":"test_id"}]}' }; 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/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests" payload := strings.NewReader("{\n \"tests\": [\n {\n \"test_id\": \"test_id\"\n }\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/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests") 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 \"tests\": [\n {\n \"test_id\": \"test_id\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests") .header("Content-Type", "application/json") .body("{\n \"tests\": [\n {\n \"test_id\": \"test_id\"\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests', [ 'body' => '{ "tests": [ { "test_id": "test_id" } ] }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"tests\": [\n {\n \"test_id\": \"test_id\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = ["tests": [["test_id": "test_id"]]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/run-tests")! 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() ```