Reference

Authoritative lookups. If a tutorial said "see the API reference for details", you're in the right place.

API#

One page per domain. Every endpoint is listed with method, path, required permission, request body shape (where non-trivial), and a sample response.

• Auth — sign in, register, refresh.
• Rooms — create, list, archive, close, export, import, DM.
• Messages and reactions — send, edit, redact, react.
• Members and directory — invite, kick, ban, browse.
• Workspaces — workspaces and their members.
• Notes — full notes surface.
• Comments — comment threads on notes.
• AI — engagement, response mode, system prompts, plugins, agents, approvals, search.
• Sidekicks and plans — agentic execution.
• Helpers and skills — specialist AI tools.
• Prompt Studio — prompt inspection and tuning.
• Artifacts — canvas documents inside rooms.
• Media and files — uploads, downloads, transcription, room-file index.
• Calls — audio/video/screenshare/recording.
• Presence and state — presence, typing, sync, state.
• Inbox and notifications — priority inbox, snooze, catchup.
• Sync — long-poll for missed events.
• Federation — server-to-server protocol + admin.
• Bridges — admin + inbound webhook.
• Profiles and preferences.
• Queue and scheduled tasks.
• Admin — tenants, partners, plugins, models, audit, statistics.
• GDPR — export, erase, consent.
• Health and metrics.

Non-API#

• WebSocket events — every event type, with payload schemas.
• CLI — the scaiwave command-line tool.
• Configuration — every SCAIWAVE_* environment variable.
• Error codes — SW_* codes with meanings.
• Slash commands — machine-readable catalog.
• Plugin protocol — BasePlugin, ToolDefinition, PluginContext.

OpenAPI#

The full OpenAPI 3.1 spec for the REST surface is served at /openapi.json. ReDoc-rendered at /redoc; Swagger UI at /docs (when SCAIWAVE_DEBUG=true).

Envelope#

Every authenticated response uses one of:

1

{ "data": <result>, "meta": { ... } }

1

{ "error": { "code": "SW_*", "message": "human-readable" } }

meta carries pagination, totals, request id; consult per-endpoint docs for what's there. Error code is a stable identifier you can match on; message may be localised.