---
title: Reference
path: reference
status: published
---

# Reference

Look up specific endpoints, schemas, configuration values, and state transitions. These pages are the source of truth for ScaiControl's external surface.

## API

The HTTP API, grouped by tag — auto-generated from the OpenAPI spec the backend serves at `/openapi.json`.

| Group | Description |
|---|---|
| [API overview](./reference/api/overview) | Conventions, auth, pagination, errors, idempotency |
| [auth](./reference/api/auth) | Login, refresh, `/auth/me` |
| [organization](./reference/api/organization) | Tenant and partner self-service |
| [catalog](./reference/api/catalog) | Browsing services + plans |
| [subscriptions](./reference/api/subscriptions) | Tenant-self subscription management |
| [service-packs](./reference/api/service-packs) | Pack discovery + subscription |
| [provisioning](./reference/api/provisioning) | DAG execution + status |
| [billing](./reference/api/billing) | Tenant invoices + billing profile |
| [service-billing](./reference/api/service-billing) | Service-token billing endpoints |
| [metering](./reference/api/metering) | Usage ingestion + queries |
| [notifications](./reference/api/notifications) | Tenant in-app notifications |
| [registry](./reference/api/registry) | Service self-registration + heartbeats |
| [entrypoints](./reference/api/entrypoints) | Service entrypoint discovery |
| [uploads](./reference/api/uploads) | Asset upload (logos, attachments) |
| [webhooks](./reference/api/webhooks) | Inbound webhook receivers (Stripe, Mollie, etc.) |
| [admin](./reference/api/admin) | Cross-cutting admin endpoints |
| [admin-tenants](./reference/api/admin-tenants), [admin-partners](./reference/api/admin-partners), [admin-users](./reference/api/admin-users), [admin-groups](./reference/api/admin-groups) | Operator-side identity + org management |
| [admin-subscriptions](./reference/api/admin-subscriptions), [admin-packs](./reference/api/admin-packs) | Operator-side subscription + pack control |
| [admin-billing](./reference/api/admin-billing), [admin-accounting](./reference/api/admin-accounting) | Invoice/credit-note + accounting-integration admin |
| [admin-provisioning](./reference/api/admin-provisioning), [admin-platform](./reference/api/admin-platform), [admin-usage](./reference/api/admin-usage), [admin-lookups](./reference/api/admin-lookups), [admin-entrypoints](./reference/api/admin-entrypoints), [admin-webhook-subscriptions](./reference/api/admin-webhook-subscriptions) | Other operator surfaces |
| [untagged](./reference/api/untagged) | Endpoints not yet tagged |

## Events

The outbound webhook system: envelope, signing, retries, and the complete topic catalog.

| Page | Use it to |
|---|---|
| [Events overview](./reference/events/overview) | Verify a signature, understand the envelope and headers, plan a subscriber inbox |
| [Events catalog](./reference/events/catalog) | Look up the exact payload shape for any of the 14 v1.0 topics |
| [Webhooks reference](./reference/webhooks) | Operate the dispatcher: backoff schedule, retry, dead rows, idempotency |

## Operations

| Page | Use it to |
|---|---|
| [Configuration](./reference/configuration) | Look up an env var — every setting the backend reads |
| [CLI](./reference/cli) | Use `scaicontrol setup` / `sync` / `admin` |
| [State machines](./reference/state-machines) | Look up valid transitions for subscriptions, invoices, provisioning, registry, webhook deliveries |

For conceptual background, see [Concepts](./concepts). When something's wrong, see [Troubleshooting](./troubleshooting).