API reference
Every public Flambe endpoint, generated from the OpenAPI spec and verified against the running server.
All 131 public operations, grouped by resource in the sidebar. Each page carries the full request and response schema, examples, and an interactive playground.
The spec
The reference is rendered from a single OpenAPI 3.1 document, which you can also consume directly:
The API serves the same document at
api.flambe.dev/openapi.json,
byte-identical and verified on every build — so a client generated from either
URL describes the same API.
It is safe to generate from. Three checks run in CI: every mounted route must be documented and vice versa, every field the API validates must appear in the request schema, and every operation must say what success looks like. Each fails the build rather than warning. How this reference stays true explains what that does and does not guarantee.
Deliberately excluded from the public surface: service-to-service endpoints
under /api/internal, operator-only endpoints under /api/admin, and the
inbound /api/webhooks handlers. They exist, but no token issued to a
third-party integration can call them.
Before you start
- Base URL —
https://api.flambe.dev. No sandbox host; use a test user. - Auth —
Authorization: Bearer <clerk session jwt>on everything exceptGET /healthandGET /api/shared/{token}. See Authentication. - Casing —
snake_case, except timers, which arecamelCase. - Errors —
{ "error": "..." }, or{ "errors": [...] }when validation failed. See Errors and retries.
Where to start reading
Plain-text context
llms.txt, llms-full.txt, and Markdown for every page.
Create a realtime assistant session POST
Mints a short-lived client secret for the hands-free cooking assistant, so a client can open a realtime connection without ever holding a long-lived provider key. Scope it to a recipe with `recipeId`. The secret expires quickly — request one per session, at the moment the user starts talking, rather than caching it.