Skip to main content
GET
Resolve Conversation Reference

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Query Parameters

agent_id
string
required

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

Examples:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

"seng_3701k3ttaq12ewp8b7qv5rfyszkz"

reference
string
required

A Slack message URL or a Zendesk ticket URL.

Examples:

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

"https://your-team.slack.com/archives/C0123ABCD/p1700000000123456"

Response

Successful Response

agent_id
string
required
status
enum<string>
required
Available options:
initiated,
in-progress,
processing,
done,
failed
metadata
ConversationHistoryMetadataCommonModel · object
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
ConversationHistoryTranscriptResponseModel · object[]
required
agent_name
string | null
conversation_product
string
default:agent
user_id
string | null
branch_id
string | null
version_id
string | null

The ID of the agent version used for this conversation

analysis
ConversationHistoryAnalysisCommonModel · object | null
visited_agents
VisitedAgentRef · object[]
conversation_initiation_client_data
ConversationInitiationClientDataRequest · object
environment
string
default:production
tag_ids
string[]

Conversation tag ids assigned to this conversation.

otlp_traces
object | null

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