Rensei docs
API ReferenceCollections

Append an immutable collection schema version

Append an immutable collection schema version - Rensei REST API operation reference.

POST
/api/collections/{collectionId}/schema

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

collectionId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

projectId*string
Length1 <= length <= 128

Request Body

application/json
  1. body
expectedVersion*integer
Range1 <= value <= 9007199254740991
schema*
indexEmbed?array<>
Itemsitems <= 32

Response Body

Success

application/json
  1. response
indexEmbed*array<string>|null
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
orgId*string
projectId*string
name*string
keyField*string
retentionClass*string
agentWrite*string
Value in"none""append""write"
schemaVersion*integer
Range-9007199254740991 <= value <= 9007199254740991
createdAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
schema?
Example Request
curl -X POST 'https://app.rensei.ai/api/collections/497f6eca-6276-4993-bfeb-53cbbbba6f08/schema?projectId=string' \  -H 'Content-Type: application/json' \  -d '{  "expectedVersion": 1,  "schema": {    "property1": "string",    "property2": "string"  }}'
Example Response
{  "indexEmbed": [    "string"  ],  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "orgId": "string",  "projectId": "string",  "name": "string",  "keyField": "string",  "retentionClass": "string",  "agentWrite": "none",  "schemaVersion": -9007199254740991,  "createdAt": "2019-08-24T14:15:22Z",  "schema": {    "property1": "string",    "property2": "string"  }}

Read immutable record history, newest first

Read immutable record history, newest first - Rensei REST API operation reference.

Trigger credential rotation fan-out

Called by the operator (CLI or admin UI) after rotating an upstream credential (Vault, 1Password, encrypted DB row, …). Re-resolves the `(orgId, kind)` tuple via the credential provider registry and fans the fresh value out to every live `rotate-stream` SSE subscriber for that org. Zero live subscribers is not an error. Auth: `Bearer rsk_*` via `getCliOrSessionAuth`. The `orgId` in the body must match the authenticated org. For `session` / `user_token` auth the caller must have `admin` or `owner` role; for `api_key` auth the cross-tenant guard is sufficient. The audit write is deferred (`after()`) and failures are non-fatal - the fan-out already fired.