v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

List box events

Return Box work, lifecycle, and progress events so product UIs can show what the box is doing. Event payloads are extensible. Clients can long-poll this endpoint with sort=asc and a cursor to stream responses. Response events expose agent text, streaming partials via data.is_streaming, and tool calls/results via data.tools.

get/boxes/{boxId}/events

Path parameters

boxIdstring required

Public Box id returned by create/list/get box calls.

Query parameters

limitinteger

Maximum items to return.

cursorstring nullable

Opaque pagination cursor returned as pageInfo.nextCursor.

sort'asc' | 'desc'

Sort direction for cursor pagination.

typestring

Comma-separated event type filter, for example prompt,response,git_checkpoint.

Response

Box work and lifecycle events.

okboolean required
type'events.list' required

Stable success envelope discriminator added by v1.

idstring required

Example response

{
  "ok": true
}