Base URL
/v0. Requests and responses are JSON unless a page says otherwise.
Credentials
Send a credential in theauthorization header. Each endpoint’s page says which credential it takes:
Reach
Writes follow the same rule as events. An install can insert blocks and post replies in public circles and in private circles the app was invited to, and never in connected circles. A development install can only write in circles its developer belongs to. A target outside that reach answersReintersectApiConversationNotFoundError or ReintersectApiReplyNotFoundError, exactly as if it didn’t
exist. Block updates only touch blocks the same install created. See
Install and consent.
The app as author
Replies, blocks and notifications your app creates are attributed to your app in that workspace, with its name and icon.Errors
An error response is JSON with a_tag naming the failure, a message, the path of the field that
caused it (often empty) and the error’s own fields:
Each endpoint’s page lists its own errors; Errors lists them all.
Retries and idempotency
The API has no idempotency keys. Retry reads freely on503 and network errors, with backoff. For
writes, use the guard each endpoint offers instead of blind retries: expectedVersion on block
updates, version on reference pushes, updatedAt on search objects.
Compatibility
- Requests are strict: the API rejects unknown fields, so a typo fails the request instead of being ignored.
- Responses may gain new fields at any time. Ignore fields you don’t recognize.
- String values documented as a closed list, such as a status, may gain new values. Handle an unknown value as the most neutral option you have.
- Breaking changes go to a new version prefix.
Member API
The API also serves the member API that existed before apps, for circles, conversations, replies and files, to member API keys. The@reintersect/sdk README documents it. Apps post replies through
POST /v0/replies instead.