sessions_tail

GET

/sessions/{id}/events

const url = 'https://api.canopyhq.dev/sessions/000000000000000000000000000000000000000000000000000000000000000000000000/events?from=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.canopyhq.dev/sessions/000000000000000000000000000000000000000000000000000000000000000000000000/events?from=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

session_token

Parameters

Path Parameters

required

A stream id: 72 hex chars, the shard then the owner digest.

string

The session to read.

Query Parameters

from

required

Monotonic per-stream position, minted at the single point of intake. Producers never carry or assert one.

integer format: int64

First cursor to read, inclusive.

Monotonic per-stream position, minted at the single point of intake. Producers never carry or assert one.

integer format: int64

Cursor to stop before; absent, the tail stays open.

Responses

200

One JSON line per record: {"Ok": <record>}, or {"Err": <reason>} if the read failed. Includes compaction.requested and compaction.completed; the latter carries a tenant-readable summary. Earlier records remain on the tail and tool results stay sealed.

application/jsonstream

A landed record: the envelope plus the opaque body beneath it.

object

body

required

The opaque layers beneath the envelope.

envelope

required

The envelope: the only surface the filter is evaluated on. Trellis never reads beneath it.

object

required

Unix milliseconds, minted with the cursor at the single point of intake.

integer format: int64

cursor

required

Monotonic per-stream position, minted at the single point of intake. Producers never carry or assert one.

integer format: int64

idem

One of:

null
string

null

kind

required

A kind string and the version of its body, one unit.

object

name

required

string

version

required

integer format: int32

producer

required

Who landed a record. Asserted on the offer, checked by the write clause.

string

size

required

integer format: int32

stream

required

A stream id: 72 hex chars, the shard then the owner digest.

string

One of:

null
string

null

Example

{
  "envelope": {
    "stream": "000000000000000000000000000000000000000000000000000000000000000000000000"
  }
}

400

No from, or a cursor that did not parse.

401

No session token, or one that did not verify.

403

The token does not attach to this session.