> 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.

# Resolver referência de conversa

GET https://api.elevenlabs.io/v1/convai/conversations/resolve

Resolva uma URL de conversa (uma URL de mensagem do Slack ou uma URL de ticket do Zendesk) para o ID determinístico da conversa do agente informado e confirme que a conversa existe.

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/conversations/resolve

## 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

### Query parameters

- `agent_id` (string, required) — ID do agente (agent_…) ou ID externo do mecanismo de fala (seng_), resolvidos para o mesmo recurso subjacente.
- `reference` (string, required) — Uma URL de mensagem do Slack ou uma URL de ticket do Zendesk.

## Response

### 200

Resposta bem-sucedida

- `agent_id` (string, required)
- `status` (enum, required)
  - Allowed values: `initiated`, `in-progress`, `processing`, `done`, `failed`
- `metadata` (ConversationHistoryMetadataCommonModel, required)
- `conversation_id` (string, required)
- `has_audio` (boolean, required)
- `has_user_audio` (boolean, required)
- `has_response_audio` (boolean, required)
- `has_auxiliary_audio` (boolean, required)
- `transcript` (list of ConversationHistoryTranscriptResponseModel, required)
- `agent_name` (string, optional)
- `conversation_product` (string, optional, default: agent)
- `user_id` (string, optional)
- `branch_id` (string, optional)
- `version_id` (string, optional) — O ID da versão do agente usada nesta conversa
- `analysis` (ConversationHistoryAnalysisCommonModel, optional)
- `visited_agents` (list of VisitedAgentRef, optional)
- `conversation_initiation_client_data` (ConversationInitiationClientDataRequestOutput, optional)
- `environment` (string, optional, default: production)
- `tag_ids` (list of string, optional) — IDs de tags de conversa atribuídas a esta conversa.
- `otlp_traces` (map from string to any, optional) — Carga útil de rastreamento do OpenTelemetry quando a solicitação usa format=opentelemetry; caso contrário, é omitida.

## Errors

### 422 Conversations Resolve Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### ConversationHistoryMetadataCommonModel

- `start_time_unix_secs` (integer, required)
- `call_duration_secs` (integer, required)
- `accepted_time_unix_secs` (integer, optional)
- `queue_wait_secs` (double, optional) — Segundos durante os quais o chamador ficou na fila de espera por concorrência. Excluídos de call_duration_secs e do tempo cobrado. None quando a conversa nunca entrou na fila.
- `cost` (integer, optional)
- `deletion_settings` (ConversationDeletionSettings, optional)
- `feedback` (ConversationHistoryFeedbackCommonModel, optional)
- `authorization_method` (enum, optional, default: public)
  - Allowed values: `invalid`, `public`, `authorization_header`, `signed_url`, `shareable_link`, `livekit_token`, `livekit_token_website`, `genesys_api_key`, `avaya_api_key`, `audiocodes_api_key`, `whatsapp`, `sms`
- `charging` (ConversationChargingCommonModel, optional)
- `phone_call` (ConversationHistoryMetadataCommonModelPhoneCall, optional)
- `batch_call` (ConversationHistoryBatchCallModel, optional)
- `termination_reason` (string, optional, default: )
- `error` (ConversationHistoryErrorCommonModel, optional)
- `warnings` (list of string, optional)
- `main_language` (string, optional)
- `rag_usage` (ConversationHistoryRagUsageCommonModel, optional)
- `text_only` (boolean, optional, default: false)
- `features_usage` (FeaturesUsageCommonModel, optional)
- `eleven_assistant` (ConversationHistoryElevenAssistantCommonModel, optional)
- `initiator_id` (string, optional)
- `conversation_initiation_source` (enum, optional, default: unknown) — Enumeração que representa as possíveis origens para o início de uma conversa.
  - 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`
- `conversation_initiation_source_version` (string, optional)
- `timezone` (string, optional)
- `async_metadata` (AsyncConversationMetadata, optional) — Metadados para entrega assíncrona de conversas (Zendesk, Slack etc.).
- `whatsapp` (WhatsAppConversationInfo, optional)
- `sms` (SmsConversationInfo, optional)
- `agent_created_from` (enum, optional, default: unknown)
  - Allowed values: `cli`, `ui`, `api`, `template`, `unknown`
- `agent_last_updated_from` (enum, optional, default: unknown)
  - Allowed values: `cli`, `ui`, `api`, `template`, `unknown`
- `voice_rewards` (list of ConversationVoiceRewardModel, optional)
- `cost_fiat` (double, optional) — Custo total da conversa em moeda fiduciária, em USD, ou seja, a soma do preço do LLM e do preço da plataforma não relacionado ao LLM (o equivalente fiduciário de ``cost``). ``None`` quando nenhum dos dois estiver definido (por exemplo, em conversas anteriores ao rastreamento de custos fiduciários).

### ConversationHistoryTranscriptResponseModel

- `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 ConversationHistoryTranscriptResponseModelToolResultsItem, 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)
- `file_input` (ConversationHistoryTranscriptFileInputResponseModel, optional) — Descontinuado: o primeiro anexo neste turno. Use `file_inputs` para ver todos os anexos.
- `file_inputs` (list of ConversationHistoryTranscriptFileInputResponseModel, optional) — Todos os arquivos anexados a este turno, na ordem em que o usuário os anexou.
- `contextual_update_info` (ContextualUpdateInfo, optional)
- `reasoned` (boolean, optional, default: false)

### ConversationHistoryAnalysisCommonModel

- `call_successful` (enum, required)
  - Allowed values: `success`, `failure`, `unknown`
- `transcript_summary` (string, required)
- `evaluation_criteria_results` (map from string to ConversationHistoryEvaluationCriteriaResultCommonModel, optional)
- `data_collection_results` (map from string to DataCollectionResultCommonModel, optional)
- `evaluation_criteria_results_list` (list of ConversationHistoryEvaluationCriteriaResultCommonModel, optional)
- `data_collection_results_list` (list of DataCollectionResultCommonModel, optional)
- `call_success_score` (double, optional)
- `call_summary_title` (string, optional)
- `scoped` (list of ScopedAnalysisResult, optional)

### VisitedAgentRef

Um agente, e uma ramificação opcional, que participou da chamada, na ordem em que apareceu pela primeira vez na transcrição.

- `agent_id` (string, required)
- `branch_id` (string, optional)

### ConversationInitiationClientDataRequestOutput

- `conversation_config_override` (ConversationConfigClientOverrideOutput, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional) — ID do usuário final que participa desta conversa (para identificação do usuário proprietário do agente)
- `source_info` (ConversationInitiationSourceInfo, optional) — Informações sobre a origem do início da conversa
- `branch_id` (string, optional) — ID da ramificação do agente a ser usada nesta conversa
- `environment` (string, optional) — Ambiente a ser usado para resolver variáveis de ambiente
- `starting_workflow_node_id` (string, optional) — Se definido, inicia o workflow neste ID de nó em vez da entrada padrão.
- `procedure_ids` (list of string, optional) — Se definido, somente estes procedimentos estarão disponíveis para o agente inicial. Cada ID deve estar vinculado a esse agente; IDs desconhecidos impedem o início da conversa. Uma lista vazia desativa todos os procedimentos desse agente. Não se aplica após uma transferência de agente. Requer enable_procedure_ids_from_client.
- `dynamic_variables` (map from string to any, optional)

### ValidationError

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

### ConversationDeletionSettings

- `deletion_time_unix_secs` (integer, optional)
- `deleted_logs_at_time_unix_secs` (integer, optional)
- `deleted_audio_at_time_unix_secs` (integer, optional)
- `deleted_transcript_at_time_unix_secs` (integer, optional)
- `delete_transcript_and_pii` (boolean, optional, default: false)
- `delete_audio` (boolean, optional, default: false)

### ConversationHistoryFeedbackCommonModel

- `type` (enum, optional)
  - Allowed values: `thumbs`, `rating`
- `overall_score` (enum, optional)
  - Allowed values: `like`, `dislike`
- `likes` (integer, optional, default: 0)
- `dislikes` (integer, optional, default: 0)
- `rating` (integer, optional)
- `comment` (string, optional)

### 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.

### ConversationHistoryMetadataCommonModelPhoneCall

- `type`: `exotel`
  - `agent_number` (string, required)
  - `call_sid` (string, required)
  - `direction` (enum, required, default: inbound)
    - Allowed values: `inbound`, `outbound`
  - `external_number` (string, required)
  - `phone_number_id` (string, required)
  - `stream_sid` (string, required)
  - `call_result` (enum, optional)
    - Allowed values: `answered`, `voicemail`, `busy`, `no_answer`, `failed`
- `type`: `sip_trunking`
  - `agent_number` (string, required)
  - `call_sid` (string, required)
  - `direction` (enum, required, default: inbound)
    - Allowed values: `inbound`, `outbound`
  - `external_number` (string, required)
  - `phone_number_id` (string, required)
  - `call_id` (string, optional)
  - `call_result` (enum, optional)
    - Allowed values: `answered`, `voicemail`, `busy`, `no_answer`, `failed`
  - `sip_header_dynamic_variables` (map from string to string, optional)
- `type`: `twilio`
  - `agent_number` (string, required)
  - `call_sid` (string, required)
  - `direction` (enum, required, default: inbound)
    - Allowed values: `inbound`, `outbound`
  - `external_number` (string, required)
  - `phone_number_id` (string, required)
  - `stream_sid` (string, required)
  - `call_result` (enum, optional)
    - Allowed values: `answered`, `voicemail`, `busy`, `no_answer`, `failed`

### ConversationHistoryBatchCallModel

- `batch_call_id` (string, required)
- `batch_call_recipient_id` (string, required)
- `campaign` (BatchCallingCampaignInformation, optional)

### ConversationHistoryErrorCommonModel

- `code` (integer, required)
- `reason` (string, optional)

### ConversationHistoryRagUsageCommonModel

- `usage_count` (integer, required)
- `embedding_model` (string, required)

### FeaturesUsageCommonModel

- `language_detection` (FeatureStatusCommonModel, optional)
- `transfer_to_agent` (FeatureStatusCommonModel, optional)
- `transfer_to_number` (FeatureStatusCommonModel, optional)
- `multivoice` (FeatureStatusCommonModel, optional)
- `dtmf_tones` (FeatureStatusCommonModel, optional)
- `external_mcp_servers` (FeatureStatusCommonModel, optional)
- `pii_zrm_workspace` (boolean, optional, default: false)
- `pii_zrm_agent` (boolean, optional, default: false)
- `tool_dynamic_variable_updates` (FeatureStatusCommonModel, optional)
- `is_livekit` (boolean, optional, default: false)
- `voicemail_detection` (FeatureStatusCommonModel, optional)
- `dtmf_input` (FeatureStatusCommonModel, optional)
- `workflow` (WorkflowFeaturesUsageCommonModel, optional)
- `agent_testing` (TestsFeatureUsageCommonModel, optional)
- `versioning` (FeatureStatusCommonModel, optional)
- `file_input` (FeatureStatusCommonModel, optional)
- `freeform_procedure` (FeatureStatusCommonModel, optional)
- `structured_procedure` (FeatureStatusCommonModel, optional)

### ConversationHistoryElevenAssistantCommonModel

- `is_eleven_assistant` (boolean, optional, default: false)

### AsyncConversationMetadata

Metadados para entrega assíncrona de conversas (Zendesk, Slack etc.).

- `delivery_status` (enum, required)
  - Allowed values: `pending`, `success`, `failed`
- `delivery_timestamp` (integer, required)
- `external_system` (string, required)
- `external_id` (string, required)
- `delivery_error` (string, optional)
- `external_link` (string, optional)
- `retry_count` (integer, optional, default: 0)
- `last_retry_timestamp` (integer, optional)
- `last_processed_external_message_id` (string, optional)

### WhatsAppConversationInfo

- `whatsapp_user_id` (string, required)
- `direction` (enum, optional, default: unknown)
  - Allowed values: `inbound`, `outbound`, `unknown`
- `whatsapp_phone_number_id` (string, optional)
- `awaiting_first_user_message` (boolean, optional)
- `recipient` (WhatsAppRecipient, optional) — Um usuário do WhatsApp por número de telefone e/ou BSUID; o telefone tem prioridade quando um deles é necessário.
- `call_permission_request` (WhatsAppCallPermissionRequest, optional)

### SmsConversationInfo

- `direction` (enum, required)
  - Allowed values: `inbound`, `outbound`
- `sms_user_phone_number` (string, required)
- `phone_number_id` (string, optional)
- `agent_phone_number` (string, optional)

### ConversationVoiceRewardModel

- `voice_id` (string, required)
- `reward_usd_cents` (double, required)

### 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)

### ConversationHistoryTranscriptResponseModelToolResultsItem

### 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)

### ConversationHistoryTranscriptFileInputResponseModel

- `file_id` (string, required)
- `original_filename` (string, required)
- `mime_type` (string, required)
- `file_url` (string, required)

### ContextualUpdateInfo

- `context_id` (string, required) — Identificador fornecido pelo cliente que agrupa atualizações contextuais relacionadas.
- `is_superseded` (boolean, optional, default: false) — True quando esta atualização contextual tiver sido substituída por uma atualização mais recente com o mesmo context_id.

### ConversationHistoryEvaluationCriteriaResultCommonModel

- `criteria_id` (string, required)
- `result` (enum, required)
  - Allowed values: `success`, `failure`, `unknown`
- `rationale` (string, required)
- `scoring_mode` (enum, optional, default: binary)
  - Allowed values: `binary`, `numeric_uniform`
- `score` (integer, optional)
- `max_score` (integer, optional)

### DataCollectionResultCommonModel

- `data_collection_id` (string, required)
- `rationale` (string, required)
- `name` (string, optional)
- `value` (any, optional)
- `json_schema` (LiteralJsonSchemaProperty, optional) — 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.

### ScopedAnalysisResult

- `scope` (enum, required, default: conversation) — O escopo da análise. 'conversation' usa a transcrição completa; 'agent' usa apenas a parte em que o agente definido estava ativo.
  - Allowed values: `conversation`, `agent`
- `source_agent_id` (string, required)
- `successful` (enum, required)
  - Allowed values: `success`, `failure`, `unknown`
- `source_branch_id` (string, optional) — Ramificação do agente para este bloco com escopo; desambigua agent_id repetidos.
- `evaluation_criteria_results` (map from string to ConversationHistoryEvaluationCriteriaResultCommonModel, optional)
- `data_collection_results` (map from string to DataCollectionResultCommonModel, optional)
- `success_score` (double, optional)

### 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

### ConversationInitiationSourceInfo

Informações sobre a origem do início da conversa

- `source` (enum, optional, default: unknown) — Origem do início da conversa
  - 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`
- `version` (string, optional) — O número da versão do SDK

### ValidationErrorLocItem

### 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.

### BatchCallingCampaignInformation

- `campaign_id` (string, required)
- `campaign_lead_id` (string, required)
- `cold_attempt` (integer, optional)
- `conversation_type` (enum, optional)
  - Allowed values: `initial`, `retry`, `callback`, `redirect`

### FeatureStatusCommonModel

- `enabled` (boolean, optional, default: false)
- `used` (boolean, optional, default: false)

### WorkflowFeaturesUsageCommonModel

- `enabled` (boolean, optional, default: false)
- `tool_node` (FeatureStatusCommonModel, optional)
- `standalone_agent_node` (FeatureStatusCommonModel, optional)
- `phone_number_node` (FeatureStatusCommonModel, optional)
- `end_node` (FeatureStatusCommonModel, optional)
- `override_agent_node` (FeatureStatusCommonModel, optional)

### TestsFeatureUsageCommonModel

- `enabled` (boolean, optional, default: false)
- `tests_ran_after_last_modification` (boolean, optional, default: false)
- `tests_ran_in_last_7_days` (boolean, optional, default: false)

### WhatsAppRecipient

Um usuário do WhatsApp por número de telefone e/ou BSUID; o telefone tem prioridade quando um deles é necessário.

- `phone` (string, optional)
- `bsuid` (string, optional)

### WhatsAppCallPermissionRequest

- `state` (enum, required)
  - Allowed values: `blocked`, `sent`, `accepted`, `declined`
- `requested_at_unix` (integer, 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)

### 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.

### 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

### 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)

### 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 <active-procedures> 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)

### LiteralJsonSchemaPropertyType

### 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.

### LiteralJsonSchemaPropertyConstantValue

Um valor constante para usar nesta propriedade. Mutuamente exclusivo com description, dynamic_variable, is_system_provided e is_omitted.

### 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.

### 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)

### 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

### 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

### 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)

### 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`

### WorkflowToolNestedToolsStepModelOutputResultsItem

## Examples

**Response**

```json
{
  "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
  "status": "processing",
  "metadata": {
    "start_time_unix_secs": 1714423232,
    "call_duration_secs": 10,
    "accepted_time_unix_secs": 1,
    "queue_wait_secs": 1.1,
    "cost": 1,
    "deletion_settings": {
      "deletion_time_unix_secs": 1,
      "deleted_logs_at_time_unix_secs": 1,
      "deleted_audio_at_time_unix_secs": 1,
      "deleted_transcript_at_time_unix_secs": 1,
      "delete_transcript_and_pii": true,
      "delete_audio": true
    },
    "feedback": {
      "type": "thumbs",
      "overall_score": "like",
      "likes": 1,
      "dislikes": 1,
      "rating": 1,
      "comment": "comment"
    },
    "authorization_method": "invalid",
    "charging": {
      "dev_discount": true,
      "is_burst": true,
      "tier": "tier",
      "llm_price": 1.1,
      "llm_charge": 1,
      "call_charge": 1,
      "platform_charge": 1,
      "platform_price": 1.1,
      "free_minutes_consumed": 1.1,
      "free_llm_dollars_consumed": 1.1,
      "analysis": {
        "total": {},
        "last_run": {}
      }
    },
    "phone_call": {
      "type": "exotel",
      "agent_number": "agent_number",
      "call_sid": "call_sid",
      "direction": "inbound",
      "external_number": "external_number",
      "phone_number_id": "phone_number_id",
      "stream_sid": "stream_sid",
      "call_result": "answered"
    },
    "batch_call": {
      "batch_call_id": "batch_call_id",
      "batch_call_recipient_id": "batch_call_recipient_id",
      "campaign": {
        "campaign_id": "campaign_id",
        "campaign_lead_id": "campaign_lead_id"
      }
    },
    "termination_reason": "termination_reason",
    "error": {
      "code": 1,
      "reason": "reason"
    },
    "warnings": [
      "warnings"
    ],
    "main_language": "main_language",
    "rag_usage": {
      "usage_count": 1,
      "embedding_model": "embedding_model"
    },
    "text_only": true,
    "features_usage": {
      "pii_zrm_workspace": true,
      "pii_zrm_agent": true,
      "is_livekit": true
    },
    "eleven_assistant": {
      "is_eleven_assistant": true
    },
    "initiator_id": "initiator_id",
    "conversation_initiation_source": "unknown",
    "conversation_initiation_source_version": "conversation_initiation_source_version",
    "timezone": "timezone",
    "async_metadata": {
      "delivery_status": "pending",
      "delivery_timestamp": 1,
      "external_system": "external_system",
      "external_id": "external_id",
      "delivery_error": "delivery_error",
      "external_link": "external_link",
      "retry_count": 1,
      "last_retry_timestamp": 1,
      "last_processed_external_message_id": "last_processed_external_message_id"
    },
    "whatsapp": {
      "whatsapp_user_id": "whatsapp_user_id",
      "direction": "inbound",
      "whatsapp_phone_number_id": "whatsapp_phone_number_id",
      "awaiting_first_user_message": true,
      "call_permission_request": {
        "state": "blocked"
      }
    },
    "sms": {
      "direction": "inbound",
      "sms_user_phone_number": "sms_user_phone_number",
      "phone_number_id": "phone_number_id",
      "agent_phone_number": "agent_phone_number"
    },
    "agent_created_from": "cli",
    "agent_last_updated_from": "cli",
    "voice_rewards": [
      {
        "voice_id": "voice_id",
        "reward_usd_cents": 1.1
      }
    ],
    "cost_fiat": 1.1
  },
  "conversation_id": "conv_7401k5m9x2p8ec3rqv6dtnhb0fzw",
  "has_audio": true,
  "has_user_audio": true,
  "has_response_audio": true,
  "has_auxiliary_audio": true,
  "transcript": [
    {
      "role": "user",
      "time_in_call_secs": 10,
      "agent_metadata": {
        "agent_id": "agent_id"
      },
      "message": "Hello, how are you?",
      "multivoice_message": {
        "parts": [
          {
            "text": "text",
            "voice_label": null,
            "time_in_call_secs": null
          }
        ]
      },
      "tool_calls": [
        {
          "request_id": "request_id",
          "tool_name": "tool_name",
          "params_as_json": "params_as_json",
          "tool_has_been_called": true
        }
      ],
      "tool_results": [
        {
          "is_error": true,
          "request_id": "request_id",
          "result_value": "result_value",
          "tool_has_been_called": true,
          "tool_name": "tool_name"
        }
      ],
      "feedback": {
        "score": "like",
        "time_in_call_secs": 1
      },
      "llm_override": "llm_override",
      "producing_llm": "producing_llm",
      "rag_retrieval_info": {
        "chunks": [
          {
            "document_id": "document_id",
            "chunk_id": "chunk_id",
            "vector_distance": 1.1
          }
        ],
        "embedding_model": "e5_mistral_7b_instruct",
        "retrieval_query": "retrieval_query",
        "rag_latency_secs": 1.1
      },
      "interrupted": true,
      "ignored_as_backchannel": true,
      "platform_event": "user_turn_timeout",
      "original_message": "original_message",
      "reasoning": [
        {}
      ],
      "source_medium": "audio",
      "source_event_id": 1,
      "used_static_kb_document_ids": [
        "used_static_kb_document_ids"
      ],
      "user_identifier": "user_identifier",
      "id": "id",
      "triggered_guardrails": [
        {
          "guardrail_type": "custom"
        }
      ],
      "file_input": {
        "file_id": "file_id",
        "original_filename": "original_filename",
        "mime_type": "mime_type",
        "file_url": "file_url"
      },
      "file_inputs": [
        {
          "file_id": "file_id",
          "original_filename": "original_filename",
          "mime_type": "mime_type",
          "file_url": "file_url"
        }
      ],
      "contextual_update_info": {
        "context_id": "context_id"
      },
      "reasoned": true
    }
  ],
  "agent_name": "My agent",
  "conversation_product": "conversation_product",
  "user_id": "user_id",
  "branch_id": "branch_id",
  "version_id": "agtvrsn_5xM3yVvZQKV0EfqQpLr2",
  "analysis": {
    "call_successful": "success",
    "transcript_summary": "transcript_summary",
    "evaluation_criteria_results": {
      "key": {
        "criteria_id": "criteria_id",
        "result": "success",
        "rationale": "rationale"
      }
    },
    "data_collection_results": {
      "key": {
        "data_collection_id": "data_collection_id",
        "rationale": "rationale",
        "json_schema": {
          "type": "string",
          "description": "A user-provided message"
        }
      }
    },
    "evaluation_criteria_results_list": [
      {
        "criteria_id": "criteria_id",
        "result": "success",
        "rationale": "rationale"
      }
    ],
    "data_collection_results_list": [
      {
        "data_collection_id": "data_collection_id",
        "rationale": "rationale",
        "json_schema": {
          "type": "string",
          "description": "A user-provided message"
        }
      }
    ],
    "call_success_score": 1.1,
    "call_summary_title": "call_summary_title",
    "scoped": [
      {
        "scope": "conversation",
        "source_agent_id": "source_agent_id",
        "successful": "success"
      }
    ]
  },
  "visited_agents": [
    {
      "agent_id": "agent_id",
      "branch_id": "branch_id"
    }
  ],
  "conversation_initiation_client_data": {
    "conversation_config_override": {
      "asr": {
        "keywords": [
          "hello",
          "world"
        ]
      },
      "turn": {
        "soft_timeout_config": {
          "message": "Hhmmmm...yeah."
        }
      },
      "tts": {
        "model_id": "eleven_turbo_v2",
        "voice_id": "cjVigY5qzO86Huf0OWal",
        "stability": 0.5,
        "speed": 1,
        "similarity_boost": 0.8,
        "pronunciation_dictionary_locators": [
          {
            "pronunciation_dictionary_id": "pronunciation_dictionary_id",
            "version_id": null
          }
        ]
      },
      "conversation": {
        "max_duration_seconds": 600
      },
      "agent": {
        "first_message": "Hello, how can I help you today?",
        "language": "en",
        "prompt": {
          "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
          "llm": "gemini-2.0-flash-001",
          "tool_ids": [
            "tool_ids"
          ],
          "knowledge_base": [
            {
              "type": "file",
              "name": "My Knowledge Base",
              "id": "123",
              "usage_mode": "auto"
            }
          ]
        }
      }
    },
    "custom_llm_extra_body": {
      "key": "value"
    },
    "user_id": "user_id",
    "source_info": {
      "source": "unknown",
      "version": "version"
    },
    "branch_id": "branch_id",
    "environment": "environment",
    "starting_workflow_node_id": "starting_workflow_node_id",
    "procedure_ids": [
      "procedure_ids"
    ],
    "dynamic_variables": {
      "key": "value"
    }
  },
  "environment": "production",
  "tag_ids": [
    "tag_ids"
  ],
  "otlp_traces": {
    "key": "value"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/conversations/resolve"

querystring = {"agent_id":"agent_3701k3ttaq12ewp8b7qv5rfyszkz","reference":"https://your-domain.zendesk.com/agent/tickets/12345"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345';
const options = {method: 'GET'};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345"

	req, _ := http.NewRequest("GET", url, nil)

	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/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345")

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

request = Net::HTTP::Get.new(url)

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

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

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/conversations/resolve?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&reference=https%3A%2F%2Fyour-domain.zendesk.com%2Fagent%2Ftickets%2F12345")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```