Agents Platform

Resolve Conversation Reference

Resolve a conversation URL (a Slack message URL or a Zendesk ticket URL) to the deterministic conversation ID for the given agent, then confirm the conversation exists.

get/v1/convai/conversations/resolve

Query parameters

agent_idstring required

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

referencestring required

A Slack message URL or a Zendesk ticket URL.

Example:https://your-domain.zendesk.com/agent/tickets/12345

A Slack message URL or a Zendesk ticket URL.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

agent_idstring required

agent_namestring nullable

conversation_productstring

status'initiated' | 'in-progress' | 'processing' | 'done' | 'failed' required

user_idstring nullable

branch_idstring nullable

version_idstring nullable

The ID of the agent version used for this conversation

environmentstring

conversation_idstring required

has_audioboolean required

has_user_audioboolean required

has_response_audioboolean required

has_auxiliary_audioboolean required

tag_idsstring[]

Conversation tag ids assigned to this conversation.

otlp_tracesobject nullable

OpenTelemetry trace payload when the request uses format=opentelemetry; otherwise omitted.

Example response

{
  "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
  "agent_name": "My agent",
  "conversation_id": "conv_7401k5m9x2p8ec3rqv6dtnhb0fzw",
  "environment": "production",
  "has_audio": true,
  "has_auxiliary_audio": true,
  "has_response_audio": true,
  "has_user_audio": true,
  "metadata": {
    "call_duration_secs": 10,
    "start_time_unix_secs": 1714423232
  },
  "status": "processing",
  "tag_ids": [],
  "transcript": [
    {
      "message": "Hello, how are you?",
      "role": "user",
      "time_in_call_secs": 10
    }
  ],
  "version_id": "agtvrsn_5xM3yVvZQKV0EfqQpLr2"
}

Changes

Changed in 22 of the 49 revisions of this API.105149

Sep 26, 20264a6716242c9e4See the full diff
- ●
  added the new deepseek-v41-flash enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new deepseek-v41-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new deepseek-v41-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new deepseek-v41-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 23, 2026ee57929773bf12See the full diff
- ●
  added the new glm-52 enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new glm-52 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new glm-52 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new glm-52 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-luna enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-luna enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-luna enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-luna enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-sol enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-sol enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-sol enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-sol enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 23, 2026cefd6ab6f6108See the full diff
- ●
  added the new claude-opus-5 enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5-5 enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new claude-opus-5-5 enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 15, 2026101ef23e39584See the full diff
- ●
  added the new gpt-6-astra enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-astra enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-astra enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gpt-6-astra enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 11, 20268125bd2e0ff93See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 9, 20260d8d57e641834See the full diff
- ●
  added the new gemini-3.8-flash enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new gemini-3.8-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gemini-3.8-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new gemini-3.8-flash enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 8, 20261eeefe174b1d22See the full diff
- ▲
  added to the ////// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the ////////////// response property oneOf list for the response status
  response-property-one-of-added
- ○
  added end_procedure_error end_procedure_success start_procedure_error start_procedure_success discriminator mapping keys to the ////// response property for the response status
  response-property-discriminator-mapping-added
- ○
  added end_procedure_error end_procedure_success start_procedure_error start_procedure_success discriminator mapping keys to the ////////////// response property for the response status
  response-property-discriminator-mapping-added
Sep 4, 2026d393c67c384a9See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  response property analysis/anyOf[subschema #1: ConversationHistoryAnalysisCommonModel]/data_collection_results/additionalProperties/json_schema/anyOf[subschema #1: LiteralJsonSchemaProperty]/allowed_values_dynamic_variable deprecated
  response-property-deprecated
- ○
  response property analysis/anyOf[subschema #1: ConversationHistoryAnalysisCommonModel]/data_collection_results_list/items/json_schema/anyOf[subschema #1: LiteralJsonSchemaProperty]/allowed_values_dynamic_variable deprecated
  response-property-deprecated
- ○
  response property analysis/anyOf[subschema #1: ConversationHistoryAnalysisCommonModel]/scoped/items/data_collection_results/additionalProperties/json_schema/anyOf[subschema #1: LiteralJsonSchemaProperty]/allowed_values_dynamic_variable deprecated
  response-property-deprecated
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 28, 2026661c61f66f751See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Aug 27, 2026f366bca2ae3c11See the full diff
- ●
  added the new dtmf enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added

Full history (22 revisions)