Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
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.

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