REST API

Hit Codexroom directly from any service.

The REST API mirrors the MCP tools for direct server-to-server integrations. Service tokens authenticate. The structured error envelope holds across every endpoint.

Authentication

Service tokens with bearer auth.

Service tokens issued per workspace. Bearer auth on every request. Token revocation through the admin UI or the API itself.

Endpoints by resource

Eight resource groups. The shape stays consistent.

Tokens

GET/api/tokens
POST/api/tokens
PATCH/api/tokens/:id
POST/api/tokens/:id/publish

Slot types

GET/api/slot-types
POST/api/slot-types
PATCH/api/slot-types/:id

Templates

GET/api/templates
POST/api/templates
PATCH/api/templates/:id
POST/api/templates/:id/publish

Assets

GET/api/assets
POST/api/assets/query
POST/api/assets
PATCH/api/assets/:id

Decks

POST/api/decks
GET/api/decks/:id
PATCH/api/decks/:id
POST/api/decks/:id/validate
POST/api/decks/:id/render-html

Shares

POST/api/decks/:id/shares
GET/api/decks/:id/shares
PATCH/api/shares/:id
POST/api/shares/:id/revoke
POST/api/shares/:id/rotate-token

Analytics

GET/api/decks/:id/analytics
GET/api/shares/:id/sessions

Exports

POST/api/decks/:id/export/pdf
POST/api/decks/:id/export/pptx

The error envelope

One typed shape across every endpoint.

Every error returns a typed JSON body with code, message, details, and a request_id. The full vocabulary lives in the API spec.

Webhooks

Signed events for shares, decks, and templates.

Subscribe to events on shares, decks, and templates. Events POST to a URL you supply with HMAC-SHA256 signatures.

Rate limits

Published per endpoint.

Published per endpoint. Documented in headers on every response.

See it work

Read the OpenAPI spec.