API reference
The full HTTP API surface, organised by OpenAPI tag. Each page below is auto-generated from the live OpenAPI spec served at GET /openapi.json — so it always reflects the deployed version, including the exact JSON schemas, request/response shapes, parameters, and security requirements.
Read API overview first if you're new to the API — it covers auth, pagination, error format, and the conventions used across every page.
Tenant-facing API#
What end-customers and tenant-context users interact with.
- auth
- organization
- catalog
- subscriptions
- service-packs
- provisioning
- billing
- metering
- notifications
- entrypoints
- uploads
Service-to-service API#
What ScaiLabs services call against ScaiControl.
- registry — register, heartbeat, fetch entrypoints
- service-billing — service-token-scoped billing
- webhooks — inbound webhook receivers from payment providers
Admin API#
Operator surfaces, gated on admin:* scopes or the super_admin role.
- admin — cross-cutting endpoints
- admin-tenants
- admin-partners
- admin-users
- admin-groups
- admin-subscriptions
- admin-packs
- admin-billing
- admin-accounting
- admin-provisioning
- admin-platform
- admin-usage
- admin-lookups
- admin-entrypoints
- admin-webhook-subscriptions
Unclassified#
- untagged — endpoints without a tag in the OpenAPI spec
Live spec#
Always available at GET /openapi.json. Swagger UI at GET /docs (Swagger UI) and GET /redoc (ReDoc) for in-browser exploration with try-it-out support.