Rensei docs
API ReferenceDispatch

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.

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

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

readerSessionId*string
Length1 <= length <= 256
roles?string
Lengthlength <= 1024
addressedOnly?string
Value in"0""1""true""false"
limit?integer
Range1 <= value <= 200

Response Body

Unread records for the reader.

application/json
  1. response
ledgerVersion*string
programVersion*string
programId*string
Match^prog_[0-9a-f]{32}$
records*array<>
Itemsitems <= 200
Example Request
curl -X GET 'https://app.rensei.ai/api/cli/programs/string/reads?readerSessionId=string'
Example Response
{  "ledgerVersion": "rensei.session-ledger/v1alpha1",  "programVersion": "rensei.session-ledger.program/v1alpha1",  "programId": "string",  "records": [    {      "ledgerVersion": "rensei.session-ledger/v1alpha1",      "programVersion": "rensei.session-ledger.program/v1alpha1",      "programId": "string",      "recordId": "string",      "kind": "decision",      "title": "string",      "body": "string",      "refs": {        "issues": [          "string"        ],        "commits": [          "string"        ],        "sessions": [          "string"        ]      },      "recipients": [        {          "kind": "session",          "id": "string"        }      ],      "replyToRecordId": "string",      "supersedesRecordId": "string",      "author": {        "kind": "human",        "id": "string"      },      "idempotencyKey": "string",      "createdAt": "2019-08-24T14:15:22Z",      "unreadReason": "addressed"    }  ]}

Read ordered structured-reference events for one program ledger.

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

Mark program records read for one reader session.

Idempotent: re-marking an already-read record marks nothing new. Record ids outside the program are ignored so a caller cannot probe record existence across programs. The reader attribution is derived from the authenticating principal; readerSessionId is the opaque session cookie being marked.