Skip to main content
The gateway exposes versioned JSON endpoints below /api/v1. This documentation’s generated endpoint pages use the repository’s OpenAPI 3.0 document and include an interactive Mintlify request playground.
The bundled OpenAPI server is http://localhost:3002/api/v1. For a self-hosted deployment, select or substitute your own public gateway origin before sending a request.

​
Base URL

The health endpoint is public:

​
Response envelope

​
success
boolean
required
Whether the gateway completed the request successfully.
​
message
string
required
Human-readable outcome. Do not use it as a stable programmatic error code.
​
data
any
Endpoint-specific result. Omitted when there is no response payload.
​
error
string
Optional diagnostic detail on failed requests.
​
pagination
object
When present, contains page, limit, total, and pages.

​
Request conventions

  • Send JSON with Content-Type: application/json unless an endpoint says otherwise.
  • Protected operator endpoints use Authorization: Bearer <access-token>.
  • The gateway accepts or generates x-request-id and returns it in the response header for log correlation.
  • Use ISO 8601 strings for dates unless the endpoint schema specifies another form.
  • Keep record IDs opaque; do not infer their type or construct them client-side.
  • Use pagination on collection endpoints and bound page sizes.

​
Errors

Routes documented with x-ai-tool-secret are internal service endpoints. Do not call them from browsers or distribute that secret to integration clients.

Authentication

Sign up, log in, switch tenants, refresh access, and log out.

Interactive endpoints

Choose an endpoint in the API reference tab, authorize, edit parameters, and send a test request.
Last modified on July 17, 2026