Get conversation details

GET

/v1/convai/conversations/:conversation_id

Get the details of a particular conversation

conversation_idstringRequired

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

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:

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 nullOptional

conversation_productstringOptionalDefaults to agent

user_idstring or nullOptional

branch_idstring or nullOptional

version_idstring or nullOptional

The ID of the agent version used for this conversation

analysisobject or nullOptional

visited_agentslist of objectsOptional

conversation_initiation_client_dataobjectOptional

environmentstringOptionalDefaults to production

tag_idslist of stringsOptional

Conversation tag ids assigned to this conversation.

otlp_tracesmap from strings to any or nullOptional

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

422

Unprocessable Entity Error

1	{
2	"agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
3	"status": "processing",
4	"metadata": {
5	"start_time_unix_secs": 1714423232,
6	"call_duration_secs": 10,
7	"cost_fiat": 1.1
8	},
9	"conversation_id": "conv_7401k5m9x2p8ec3rqv6dtnhb0fzw",
10	"has_audio": true,
11	"has_user_audio": true,
12	"has_response_audio": true,
13	"has_auxiliary_audio": true,
14	"transcript": [
15	{
16	"role": "user",
17	"time_in_call_secs": 10,
18	"message": "Hello, how are you?"
19	}
20	],
21	"agent_name": "My agent",
22	"version_id": "agtvrsn_5xM3yVvZQKV0EfqQpLr2",
23	"environment": "production",
24	"tag_ids": []
25	}