Sign in

v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB
Conversations

Get a conversation by ID

Retrieves a single conversation, including turn-by-turn transcript, metrics, and function events.

Host: this endpoint is served from api.{region}.poly.ai — not the api.{region}-1.platform.polyai.app host used by the list-conversations and audio endpoints.

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

Path parameters

agentIdstring required

Agent ID.

conversationIdstring required

Unique conversation ID.

Response

Successful response

conversationIdstring required

Unique ID for this conversation.

accountIdstring required

ID of the customer account this conversation is under.

projectIdstring required

ID of the project this conversation is under.

createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
channelstring

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

fromNumberstring

Caller phone number.

toNumberstring

Agent phone number.

languagestring

Conversation language code.

variantIdstring

Variant ID the conversation ran in.

clientEnvstring

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

totalDurationinteger

Total call duration in seconds.

polyaiDurationinteger

PolyAI-handled duration in seconds.

durationinteger

Duration in seconds.

inProgressboolean

Whether the conversation is still in progress.

handoffboolean

Whether handoff occurred.

handoffDestinationstring

If multiple handoff destinations exist, which one was used.

handoffReasonstring

Brief handoff reason.

directionstring

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

tagsstring[]

Tags applied to the conversation.

polyScorenumber

PolyScore quality measure.

shortSummarystring

Short summary of the conversation.

deploymentIdstring

Deployment ID.

notestring

Free-text note saved on the conversation.

audioUrlstring

URL to the audio recording.

metricsobject

Custom metrics recorded for the conversation.

functionEventsobject

Function execution events that occurred during the conversation.

Example response

{
  "conversationId": "CAabcd1234567abcdef1250065d4fc7389"
}