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}

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

{
  "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,
  "shortSummary": "<string>",
  "deploymentId": "<string>",
  "note": "<string>",
  "audioUrl": "<string>",
  "turns": [
    {
      "user_input": "<string>",
      "user_input_dtmf": "<string>",
      "user_input_datetime": "2023-11-07T05:31:56Z",
      "agent_response": "<string>",
      "agent_response_datetime": "2023-11-07T05:31:56Z",
      "latency": 123,
      "translated_user_input": "<string>",
      "english_agent_response": "<string>",
      "intents": [
        "<string>"
      ],
      "entities": [
        {}
      ],
      "is_ood": true,
      "is_silence": true
    }
  ],
  "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

Public-facing conversation detail (includes turns, 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>

startedAt · string<date-time>

finishedAt · string<date-time>

channel · string

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

fromNumber · string

Caller phone number.

toNumber · string

Agent phone number.

language · string

Conversation language code.

variantId · string

Variant ID the conversation ran in.

clientEnv · string

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

totalDuration · integer

Total call duration in seconds.

polyaiDuration · integer

PolyAI-handled duration in seconds.

duration · integer

Duration in seconds.

inProgress · boolean

Whether the conversation is still in progress.

handoff · boolean

Whether handoff occurred.

handoffDestination · string

If multiple handoff destinations exist, which one was used.

handoffReason · string

Brief handoff reason.

direction · string

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

tags · string[]

Tags applied to the conversation.

polyScore · number

PolyScore quality measure.

shortSummary · string

Short summary of the conversation.

deploymentId · string

Deployment ID.

note · string

Free-text note saved on the conversation.

audioUrl · string

URL to the audio recording.

turns · object[]

Ordered list of conversation turns.

Show child attributes

metrics · object

Custom metrics recorded for the conversation.

functionEvents · object

Function execution events that occurred during the conversation.