Skip to main content
GET
List messages in a session
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/chat/listMessages?id=<sessionId> returns a session’s transcript as ChatMessage items, readable as in getSession. Pages are at most 200 messages; limit defaults to 50 and a larger value is 400 too_big. Follow meta.nextCursor while meta.hasMore is true. A missing, malformed or unreadable session is 404 resource_missing; a cursor the server cannot read is 400 bad_request.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

sessionId
string
required

Session ID

Query Parameters

limit
integer
default:50

Rows to read for this page, 1 to 200; a larger value is 400 too_big.

Required range: 1 <= x <= 200
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

Message page

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.