API Overview
The KiBee REST API powers the browser SDK, the Admin Console, and any server-side integrations you build. All endpoints are served over HTTPS and return JSON.
Base URL
Production
https://api.kibee.aiRoute groups
| Prefix | Auth required | Description |
|---|---|---|
/flows/:id | Publishable key | Fetch a flow definition by ID. Called by the browser SDK when starting a guided flow. |
/sessions | Publishable key | Create and track user sessions. |
/intent/resolve | Publishable key | Match a free-text query to the best available flow. |
/events | Publishable key | Track step completions, page visits, and custom events. |
/recovery/resolve | Publishable key | Resume a stalled session at the correct step. |
/admin/* | Admin key or Auth0 JWT | Manage flows, sessions, contacts, API keys, and workspace settings. |
Request format
POST and PUT endpoints accept application/json bodies. Always set Content-Type: application/json on requests with a body.
Error responses
All errors follow the same shape:
JSON
{ "error": "Invalid publishable key" }HTTP status codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Resource created |
204 | Success, no body (e.g. delete) |
400 | Bad request — malformed body or missing field |
401 | Unauthorized — missing or invalid credentials |
403 | Forbidden — origin not in the allowed domains list |
404 | Resource not found |
429 | Rate limited |
500 | Internal server error |
Rate limits
SDK and admin endpoints are limited to 100 requests per minute per API key by default. Contact support to increase limits for high-traffic workspaces.
Next: Authentication — learn how to sign requests with publishable keys, secret keys, and Auth0 JWTs.