ReferenceOpenAPI Spec

OpenAPI Spec

Interactive OpenAPI 3.1 reference for the CleverRouter Gateway API. Powered by Swagger UI.

The CleverRouter Gateway publishes a full OpenAPI 3.1 spec at https://api.cleverouter.eu/openapi.json. You can pipe that into any OpenAPI-aware tool — Postman, Insomnia, Stainless, openapi-typescript, Speakeasy, or your own code-gen.

The dashboard mirrors the spec at /api/openapi.json so you can fetch it without configuring CORS at the gateway. Both URLs return the same content.

Quick download

curl https://api.cleverouter.eu/openapi.json -o cleverrouter.json

Interactive explorer

The embed below loads Swagger UI directly from unpkg.com (no extra dependency in this dashboard). For an offline copy, run npx swagger-ui-watcher cleverrouter.json against the downloaded spec.

Code generation

Common workflows once you have the spec file:

# TypeScript types only
bunx openapi-typescript cleverrouter.json -o cleverrouter.ts

# Full typed client (openapi-fetch)
bun add openapi-fetch
# then use the generated types above
# Python (httpx + pydantic)
uvx datamodel-code-generator --input cleverrouter.json --output cleverrouter.py

Endpoints covered

The spec documents every public route the gateway exposes:

  • POST /v1/chat/completions
  • POST /v1/embeddings
  • POST /v1/rerank
  • POST /v1/audio/transcriptions
  • POST /v1/files, GET /v1/files, GET /v1/files/{id}, DELETE /v1/files/{id}
  • POST /v1/batches, GET /v1/batches, GET /v1/batches/{id}, POST /v1/batches/{id}/cancel
  • POST /v1/webhooks, GET /v1/webhooks
  • GET /v1/models, GET /v1/models/{id}
  • GET /v1/usage, GET /v1/usage/summary

The OpenAPI version is bumped in lock-step with the gateway release. Check the info.version field of the spec to verify which gateway you're hitting.