Get a conversation by ID

Get the full details for a single conversation, including turns, metrics, and function events.

GET /v1/agents/{agentId}/conversations/{conversationId}

Get a conversation by ID

cURL

curl --request GET \
  --url https://api.us.poly.ai/v1/agents/{agentId}/conversations/{conversationId} \
  --header 'x-api-key: <api-key>'

200

Example

{ "conversationId": "CAabcd1234567abcdef1250065d4fc7389", "accountId": "<string>", "projectId": "<string>", "createdAt": "2023-11-07T05:31:56Z", "startedAt": "2023-11-07T05:31:56Z", "finishedAt": "2023-11-07T05:31:56Z", "channel": "<string>", "fromNumber": "<string>", "toNumber": "<string>", "language": "<string>", "variantId": "<string>", "clientEnv": "<string>", "totalDuration": 123, "polyaiDuration": 123, "duration": 123, "inProgress": true, "handoff": true, "handoffDestination": "<string>", "handoffReason": "<string>", "direction": "<string>", "tags": [ "<string>" ], "polyScore": 123, "polyScoreV2": 123, "shortSummary": { "heading": "<string>", "content": "<string>" }, "deploymentId": "<string>", "note": "<string>", "audioUrl": "<string>", "turns": [ { "turn_id": 123, "user_input": "<string>", "user_input_dtmf": "<string>", "user_input_dtmf_finish_key": "<string>", "user_input_datetime": "2023-11-07T05:31:56Z", "user_input_audio_url": "<string>", "agent_response": "<string>", "agent_response_datetime": "2023-11-07T05:31:56Z", "translated_user_input": "<string>", "english_agent_response": "<string>", "intents": [ "<string>" ], "entities": "<unknown>", "is_ood": true, "is_silence": true, "barge_in": true, "asr_lang_code": "<string>", "tts_lang_code": "<string>", "latency": { "perceived_latency": 123, "perceived_latency_percentile_1d": 123, "perceived_latency_percentile_7d": 123, "perceived_latency_percentile_14d": 123, "perceived_latency_percentile_30d": 123, "label": "high" }, "metadata": {}, "llm_requests": [ {} ], "agent_annotations": {}, "user_annotations": {}, "reviews": [ {} ] } ], "metrics": {}, "functionEvents": {} }

Authorizations

x-api-key · string · header · required

Contact your PolyAI representative.

Path Parameters

agentId · string · required

Agent ID.

conversationId · string · required

Unique conversation ID.

Response

200

application/json

Successful response

Full details for a single conversation, including its turns, custom metrics, and function events.

conversationId · string · required

Unique ID for this conversation.

Example:

"CAabcd1234567abcdef1250065d4fc7389"

accountId · string · required

ID of the customer account this conversation is under.

projectId · string · required

ID of the project this conversation is under.

createdAt · string<date-time> | null

startedAt · string<date-time> | null

finishedAt · string<date-time> | null

channel · string | null

Conversation medium (e.g. WEBCHAT, VOICE-SIP).

fromNumber · string | null

Caller phone number.

toNumber · string | null

Agent phone number.

language · string | null

Conversation language code.

variantId · string | null

Variant ID the conversation ran in.

clientEnv · string | null

Client environment (sandbox, pre-release, or live).

totalDuration · integer | null

Total call duration in seconds.

polyaiDuration · integer | null

PolyAI-handled duration in seconds.

duration · integer | null

Duration in seconds.

inProgress · boolean | null

Whether the conversation is still in progress.

handoff · boolean | null

Whether handoff occurred.

handoffDestination · string | null

If multiple handoff destinations exist, which one was used.

handoffReason · string | null

Brief handoff reason.

direction · string | null

Call direction (e.g. inbound, outbound).

tags · string[]

Tags applied to the conversation.

polyScore · number | null

PolyScore quality measure.

polyScoreV2 · number | null

PolyScore on the 1-5 scale.

shortSummary · object | null

Short structured summary of the conversation.

Show child attributes

deploymentId · string | null

Deployment ID.

note · string | null

Free-text note saved on the conversation.

audioUrl · string | null

Relative path to the conversation recording, for example conversations/{conversationId}/audio.

turns · object[] | null

Ordered list of conversation turns.

Show child attributes

metrics · object | null

Custom metrics recorded for the conversation, keyed by metric name.

Show child attributes

functionEvents · object | null

Function events that occurred during the conversation, keyed by zero-based turn index.

Show child attributes