REST API — Cariosan Docs

The reference below is rendered by Scalar from the Cariosan OpenAPI spec. The viewer resolves the spec URL in this order:

NEXT_PUBLIC_CARIOSAN_OPENAPI_URL set at docs-build time — point this at a hosted Cariosan server's /openapi.json for the always-current spec.
/openapi.json served as a static snapshot from this docs site (apps/docs/public/openapi.json). Regenerate the snapshot by booting any Cariosan server, fetching /openapi.json, and committing the result into public/.

Spec stays blank? — boot any Cariosan server (docker compose up -d from the repo root), commit apps/docs/public/openapi.json from the live /openapi.json, and refresh.

Authentication

Server-side endpoints (/v1/users, /v1/channels, /v1/webhooks, etc.) take your workspace API credentials as Authorization: Bearer <api_key>:<api_secret>.
Client-side endpoints (/v1/me/channels, /v1/channels/:id/messages, /v1/attachments/presign) take a user JWT as Authorization: Bearer <jwt>. Issue these from your backend with the Go SDK's IssueUserToken.

Try it console — Scalar's "Try it" picks up whichever auth scheme the endpoint declares. Paste credentials once and it remembers them for the session.

Was this page helpful?