Get a conversation

curl --request GET \
  --url https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "8f14e45f-ceea-467f-a0e6-3f1c2b9d7a10",
  "project_id": "3c59dc04-8a4b-4f7e-9b1a-6c2a0e5d1f22",
  "platform_id": "RM_kQ3vZx7pLm2T",
  "status": "ended",
  "hangup_reason": "caller_hangup",
  "connected": true,
  "direction": "outgoing",
  "duration": 95,
  "initial_call_id": "1b6453892473a467d07372d45eb05abc",
  "initial_agent_id": "6f4922f4-5568-461a-8f1d-9c3b2a1e7d55",
  "agent_version_id": "2e1c7a90-4b1d-4c3e-9f2a-7d8e6b5a4c33",
  "participant_count": 2,
  "allow_recording": true,
  "conversation_summary": "Reminder call; the customer confirmed the delivery window.",
  "warnings": [],
  "transcription_id": null,
  "recording_id": null,
  "origin": "production",
  "csat_score": null,
  "csat_source": null,
  "campaign_id": "0d6f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
  "campaign_item_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "pii_redaction": null,
  "pii_redaction_status": null,
  "region_profile": null,
  "summary_status": "generated",
  "call_language": null,
  "clock": {
    "time_zone": "Asia/Riyadh",
    "source": "caller_number",
    "at": "2026-10-20T09:15:00.874Z",
    "hijri": false
  },
  "participants": [
    {
      "type": "agent",
      "agent_id": "6f4922f4-5568-461a-8f1d-9c3b2a1e7d55",
      "agent_metrics": null,
      "session_id": "AJ_x8Kd2mQp4Vn",
      "joined_at": "2026-10-20T09:15:02.000Z",
      "left_at": "2026-10-20T09:16:37.000Z",
      "artifacts": null
    }
  ],
  "anecdote_back_link": null,
  "created_at": "2026-10-20T09:15:00.000Z",
  "updated_at": "2026-10-20T09:16:38.000Z",
  "ended_at": "2026-10-20T09:16:37.000Z"
}

{
  "error": "Invalid or revoked token"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "Conversation not found"
}

GET

projects

{projectId}

conversations

{id}

Get a conversation

curl --request GET \
  --url https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://voice-api.onclarity.com/v1/projects/{projectId}/conversations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "8f14e45f-ceea-467f-a0e6-3f1c2b9d7a10",
  "project_id": "3c59dc04-8a4b-4f7e-9b1a-6c2a0e5d1f22",
  "platform_id": "RM_kQ3vZx7pLm2T",
  "status": "ended",
  "hangup_reason": "caller_hangup",
  "connected": true,
  "direction": "outgoing",
  "duration": 95,
  "initial_call_id": "1b6453892473a467d07372d45eb05abc",
  "initial_agent_id": "6f4922f4-5568-461a-8f1d-9c3b2a1e7d55",
  "agent_version_id": "2e1c7a90-4b1d-4c3e-9f2a-7d8e6b5a4c33",
  "participant_count": 2,
  "allow_recording": true,
  "conversation_summary": "Reminder call; the customer confirmed the delivery window.",
  "warnings": [],
  "transcription_id": null,
  "recording_id": null,
  "origin": "production",
  "csat_score": null,
  "csat_source": null,
  "campaign_id": "0d6f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
  "campaign_item_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "pii_redaction": null,
  "pii_redaction_status": null,
  "region_profile": null,
  "summary_status": "generated",
  "call_language": null,
  "clock": {
    "time_zone": "Asia/Riyadh",
    "source": "caller_number",
    "at": "2026-10-20T09:15:00.874Z",
    "hijri": false
  },
  "participants": [
    {
      "type": "agent",
      "agent_id": "6f4922f4-5568-461a-8f1d-9c3b2a1e7d55",
      "agent_metrics": null,
      "session_id": "AJ_x8Kd2mQp4Vn",
      "joined_at": "2026-10-20T09:15:02.000Z",
      "left_at": "2026-10-20T09:16:37.000Z",
      "artifacts": null
    }
  ],
  "anecdote_back_link": null,
  "created_at": "2026-10-20T09:15:00.000Z",
  "updated_at": "2026-10-20T09:16:38.000Z",
  "ended_at": "2026-10-20T09:16:37.000Z"
}

{
  "error": "Invalid or revoked token"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "Conversation not found"
}

Authorizations

Authorization

string

header

required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Path Parameters

projectId

string

required

Project id

string

required

Conversation id

Response

The conversation.

One interaction with a caller, from start to end. It can span several calls and several agent sessions (participants).

string

required

project_id

string

required

participants

object[]

required

One agent session of the conversation whose agent still exists. A deleted agent's sessions are not listed here; the artifacts route (SessionArtifacts, agent_id: null) still serves them.

Option 1
Option 2

Show child attributes

platform_id

string | null

status

string | null

pending (created, nobody connected yet), active (in progress) or ended.

hangup_reason

string | null

connected

boolean | null

Whether the caller joined. A conversation the caller never joined has no transcript.

direction

string | null

duration

integer<int64> | null

Length in seconds.

initial_call_id

string | null

initial_agent_id

string | null

The agent that took the conversation first.

agent_version_id

string | null

The agent version that served the conversation.

participant_count

integer | null

allow_recording

boolean | null

conversation_summary

string | null

origin

enum<string>

default:production

How the conversation started: production (real traffic), try_it (a test call from the web app), demo (the agent's public demo page) or eval (an evaluation run).

Available options:

production,

try_it,

demo,

eval

csat_score

integer | null

Customer satisfaction rating 1-5; null until rated.

Required range: 1 <= x <= 5

csat_source

string | null

Where the rating came from (e.g. try_it_ui, demo_ui, end_call_with_csat).

transcription_id

string | null

recording_id

string | null

pii_redaction

object | null

The organization's personal-data redaction setting as it was when the call started. Null on calls recorded before redaction existed. source: fresh / stale (read at call start, the second from cache), unavailable (could not be read; the call was not redacted), no_org (redaction not configurable for this project).

Show child attributes

pii_redaction_status

enum<string> | null

pending and in_progress mean redaction has not finished yet: the conversation's artifacts are withheld until it has. Null reads as not_required.

Available options:

not_required,

pending,

in_progress,

applied

summary_status

enum<string> | null

What happened to the conversation's summary: pending (still being written — for up to ten minutes after the call ended), generated (conversation_summary holds the text), skipped (nothing to summarize), failed, or not_enabled (the agent version has summaries off). Null on older calls.

Available options:

not_enabled,

pending,

generated,

skipped,

failed

warnings

object[]

In-call warnings raised on the conversation, most severe first. Filled by the list endpoint; always empty on the single-conversation read.

Show child attributes

campaign_id

string | null

The campaign that placed this call, if any.

campaign_item_id

string | null

The campaign item (recipient) this call belongs to, if any.

region_profile

string | null

The regional deployment profile that served the call; null for the default.

call_language

string | null

For agents that speak two languages, the language most of the call was held in. Null for single-language agents and older calls.

clock

object | null

The clock the agent worked by: its time zone, where the zone came from, the instant at call start and whether the Hijri date was included. Null for calls before this field existed and for Voice Assist calls.

Show child attributes

Example:

{
  "time_zone": "Asia/Riyadh",
  "source": "caller_number",
  "at": "2026-11-05T21:47:12.345Z",
  "hijri": false
}

ticket_category

object | null

The category of the call's ticket in the Clarity inbox. Set automatically shortly after the call ends (when automatic ticket categorization is on for your organization) and updated whenever someone changes the ticket's category. Null when the call has no ticket or its ticket has no category. Not included in the call-ended callback, which is sent before the ticket exists.

Show child attributes

Example:

{ "id": 17, "path": "Billing › Refund" }

anecdote_back_link

object | null

Link to the conversation and ticket in the Clarity inbox once the call was imported.

Show child attributes

created_at

string<date-time> | null

updated_at

string<date-time> | null

ended_at

string<date-time> | null