KAkarumi
Sessions

Get Session

Changed on

Get a session by ID with optional transcript messages.

Only returns text messages from user and assistant (excludes system messages, tool calls, and other internal message types).

The recording_url field contains a URL to download the session recording. The field is null if the session is still in progress, the recording is still processing, or the recording is unavailable.

get/sessions/{session_id}

Request

  • Base URL
    https://api.karumi.ai/api/v1
  • URL
    https://api.karumi.ai/api/v1/sessions/{session_id}
  • Auth
    none declared

Path parameters

session_idstring uuid required

Query parameters

include_messagesboolean

Include transcript messages in response

Headers

x-api-keystring nullable

Response

Successful Response

idstring uuid required
project_idstring uuid nullable required
session_type'demo_call' | 'chat' | 'phone_call'

Session channel; phone calls require session_type=phone_call on list queries.

duration_secondsinteger nullable required
statusstring required
created_atstring date-time required
emailstring nullable required
summarystring nullable required
intent_rateinteger nullable required
intent_namestring nullable required
labelsobject nullable required
metadataobject nullable required
tracked_journeysobject nullable required
excluded_from_analytics_atstring date-time nullable

Set when an operator marked this session as not counting towards analytics (monitoring or test traffic). The session is still real and still listed here — this flag is what lets you leave it out of your own numbers. Null means it counts normally.

goalsstring[]

IDs of goal journeys completed in this session

recording_urlstring nullable

URL of this API's recording download endpoint (GET /sessions/{session_id}/recording); call it with your X-Api-Key. Null if: session is still in progress, recording is processing, or recording is unavailable.

Changes