API reference

The HTTP API every Cloudoak node serves: accounts, sign-in, and each app’s tables, documents, vectors, files and change feed. Generated from the node’s route table.

This reference is generated from the spec, version 2.1.0: the node’s own route table writes it, and the node’s tests hold it to what the node serves. Download openapi.json for your own tooling.

Every path is on the node your users point the app at, such as https://node.example.com/api/v1/.... Apps usually call it through the SDK rather than by hand.

Signing in

• apiToken: An API token the account made for scripts. It reaches the account’s data in apps, as its scopes allow, and never the account itself.
• appToken: An app’s access token, from the sign-in flow (it lasts 5 minutes; the refresh token renews it). It is valid only on the app routes of the installation it was issued for.
• sessionCookie: HttpOnly session cookie plus X-CSRF-Token header on mutations.

Each operation says which of these it takes.

Errors

A failed request answers with a status code and a JSON body:

Field	Type	Required	Notes
error	object	no
error.code	string	no
error.message	string	no
error.request_id	string	no

• 400: Bad request
• 401: Authentication required
• 403: Forbidden
• 404: Not found
• 429: Rate limited

Sections

• Accounts and sign-in: 24 operations
• API tokens, credits and usage: 5 operations
• App sign-in and connected apps: 5 operations
• Tables: 7 operations
• Documents: 7 operations
• Vectors: 3 operations
• Files: 5 operations
• Change feed: 1 operation
• Node and setup: 4 operations