Skip to main content
GET
Read conversation messages

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose conversation to read.

Query Parameters

limit
integer

Maximum number of messages to return, counted back from the newest. Omit to return the whole conversation.

skip
integer
default:0

Number of messages to skip, counted back from the newest. Combine with limit to page back through the conversation. For example, skip=20 with limit=20 returns the 20 messages before the 20 most recent. Prefer cursor.

cursor
string

next_cursor from the previous page, which returns the older messages before it. Send it without skip. It carries the page size, so limit is ignored. Pages are counted back from the newest message, so a message added while you page shifts the next page by one and repeats a message you already have.

branch_id
string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Response

Successful Response

A window of messages from an app's AI chat.

id
string | null

ID of the conversation.

Example:

"1f0c2b7a-9d51-4c3e-8a62-7b4d5e6f8a90"

messages
ConversationMessageSummary · object[] | null

The requested window of messages, oldest first.

next_cursor
string | null

Cursor for fetching the next page. The value is null if there are no more pages, or if limit wasn't set.

Example:

"gAAAAABn7vJ..."