API overview
Base URL: https://api.flaazecdn.com/v1. JSON only. Every response carries request_id.
This reference is generated at build time from the schemas the API itself validates with, so a field listed here is a field the API enforces.
Headers
Section titled “Headers”| Header | Meaning |
|---|---|
X-Flaaze-Key |
A publishable key (pk) for widget calls, a secret key (sk) for server calls. |
X-Flaaze-Session |
A client-generated UUID v4 session id. |
X-Flaaze-Consumer |
Optional short-lived consumer token. |
Origin |
Validated against the key’s allowed origins for publishable keys. |
Errors
Section titled “Errors”An error is { "error": { "code", "message_id" } }. The message_id maps to fixed widget copy. Codes: key_invalid, origin_not_allowed, tenant_inactive, rate_limited, gate_required, location_required, validation_failed, unavailable, audit_failed.
Versioning
Section titled “Versioning”v1 is permanent for the snippet. Changes are additive. A breaking change ships as v2 on a new path while v1 stays maintained.
Endpoints
Section titled “Endpoints”- Widget endpoints: config, chat, feedback, help search, study application, consumer token.
- Server endpoints: catalog sync, usage, audit digests, audit export. These need a secret key.