Rensei docs
API ReferenceDispatch

Read ordered structured-reference events for one program ledger.

Read ordered structured-reference events for one program ledger. - Rensei REST API operation reference.

GET
/api/cli/programs/{programId}/events

Authorization

headerAuthorizationBearer <rsk_live_*>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

Path Parameters

programId*string
Match^prog_[0-9a-f]{32}$

Query Parameters

afterSeq?string
Match^(0|[1-9][0-9]*)$
limit?integer
Range1 <= value <= 1000
type?string
Value in"issue_created""wave_opened""wave_closed""child_dispatched""receipt_recorded""handoff_recorded"
waveId?string
Length1 <= length <= 512

Response Body

One ascending page of program events.

application/json
  1. response
ledgerVersion*string
programVersion*string
programId*string
Match^prog_[0-9a-f]{32}$
events*array<|||||>
Itemsitems <= 1000
hasMore*boolean
nextCursor*
Example Request
curl -X GET 'https://app.rensei.ai/api/cli/programs/string/events'
Example Response
{  "ledgerVersion": "rensei.session-ledger/v1alpha1",  "programVersion": "rensei.session-ledger.program/v1alpha1",  "programId": "string",  "events": [    {      "ledgerVersion": "rensei.session-ledger/v1alpha1",      "programVersion": "rensei.session-ledger.program/v1alpha1",      "programId": "string",      "eventId": "string",      "seq": "string",      "actor": {        "kind": "user",        "ref": "string"      },      "source": {        "kind": "session",        "ref": "string"      },      "projectId": "string",      "repositoryId": "string",      "waveId": "string",      "occurredAt": "2019-08-24T14:15:22Z",      "recordedAt": "2019-08-24T14:15:22Z",      "type": "issue_created",      "issue": {        "provider": "string",        "ref": "string"      }    }  ],  "hasMore": true,  "nextCursor": {    "afterSeq": "string"  }}

Read one program-ledger record.

Read one program-ledger record. - Rensei REST API operation reference.

Read the unread mailbox records for one reader session.

The reader's unread mail, newest first: un-read, un-superseded broadcasts plus records addressed to readerSessionId or to one of the comma-separated roles it claims. Mail addressed to any other reader never appears. addressedOnly (true/false or 1/0) drops the broadcasts. Visibility matches the program itself.