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.

Headers

xi-api-keystringOptional

Query parameters

agent_idstringRequired

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

referencestringRequired
A Slack message URL or a Zendesk ticket URL.

Response

Successful Response
agent_idstring
statusenum
metadataobject
conversation_idstring
has_audioboolean
has_user_audioboolean
has_response_audioboolean
has_auxiliary_audioboolean
transcriptlist of objects
agent_namestring or null
conversation_productstringDefaults to agent
user_idstring or null
branch_idstring or null
version_idstring or null
The ID of the agent version used for this conversation
analysisobject or null
visited_agentslist of objects
conversation_initiation_client_dataobject
environmentstringDefaults to production
tag_idslist of strings
Conversation tag ids assigned to this conversation.
otlp_tracesmap from strings to any or null

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

Errors

422
Unprocessable Entity Error