Skip to main content
GET
List session events

Authorizations

Authorization
string
header
required

An API token for one organization. You create and revoke tokens in the dashboard. A token scoped to one App can reach only that App, so give that kind of token to an agent. An organization-wide token can create a short-lived one with POST /api/tokens.

Headers

Last-Event-ID
integer

For streams, the sequence of the last event that you received. The stream resumes after it, and the header takes precedence over cursor.

Required range: x >= 0

Path Parameters

id
string
required

A unique ID that starts with app_.

Pattern: ^app_[0-9A-Za-z]{24}$
Example:

"app_Zj7XhMgplmTJcp5Dk4vcYuk0"

session_id
string
required

A unique ID that starts with ses_.

Pattern: ^ses_[0-9A-Za-z]{24}$
Example:

"ses_Zj7XhMgplmTJcp5Dk4vcYuk0"

Query Parameters

cursor
integer
default:0

Returns only events whose sequence is greater than this value.

Required range: x >= 0
limit
integer
default:100

The maximum number of events to return. Applies only to JSON responses.

Required range: 1 <= x <= 1000

Response

One page of events, or the live stream.

results
(message · object | turn.started · object | tool.started · object | tool.completed · object | input.requested · object | input.resolved · object | turn.completed · object | turn.failed · object | turn.cancelled · object)[]
required

The results in this page.

A message from the user or the agent.

has_more
boolean
required

True if more results follow this page; false otherwise.

next_cursor
string | null
required

Where the next page starts: to get it, list again with this value as cursor. A cursor from the last page later finds results added after it. Null if the list is empty.