API referenceConversations

Get conversation details

Get the details of a particular conversation

Path parameters

conversation_idstringRequired
The id of the conversation you're taking the action on.

Headers

xi-api-keystringOptional

Query parameters

formatenumOptionalDefaults to json

Response format. Defaults to ‘json’. Set to ‘opentelemetry’ for an OTLP-compatible trace payload using the same structure as the post-call webhook.

Allowed values:

Response

Successful Response
agent_idstring
statusenum
Allowed values:
metadataobject
conversation_idstring
has_audioboolean
has_user_audioboolean
has_response_audioboolean
transcriptlist of objects
agent_namestring or null
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