transcripts

Read a saved conversation using its opaque source reference

Uses the same authorized indexed reader as the session route.

get/api/v1/transcripts/read

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/transcripts/read
  • Auth
    HTTP bearer

Query parameters

source_refstring

Opaque source reference returned by discovery, required on the source route unless continuing with a cursor.

cursorstring
limitinteger
max_bytesinteger
include_toolsboolean
around_eventinteger

Cited event index, paired with event_digest and without cursor.

event_digeststring

Response

Indexed events or an explicit content availability state.

status'available' | 'preparing' | 'pending' | 'unavailable' | 'expired' | 'no_checkpoint' required
session_idstring required
checkpoint_idstring nullable required
source_refstring nullable required
scope'checkpoint' | 'whole_session' required
older_cursorstring nullable required
has_moreboolean required
contains_truncated_eventsboolean required
truncation_noticestring nullable required
newer_cursorstring nullable required

Changes

No recorded changes to this operation across all 3 revisions of this API.