> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sndbox.app/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI document

> Generate clients and inspect the same OpenAPI 3.1 contract served by the control plane.

The source contract is `docs/api/openapi-v1.json`. The docs generator copies it to `apps/docs/api-reference/openapi.json`, and Mintlify creates one interactive reference page per operation.

## From a running service

```bash theme={"system"}
curl https://api.sndbox.app/v1/openapi.json -o openapi.json
```

## Repository drift check

After changing control-plane routes:

```powershell theme={"system"}
npm.cmd run openapi:generate --workspace @sandbox/control-plane
npm.cmd run openapi:check --workspace @sandbox/control-plane
```

Compatibility tests reject unresolved operation references and the removed broad `JsonValue` fallback. Every stable operation has named request and response schemas; several core resources also use closed field-level schemas.

<Note>
  Generated clients must still preserve unknown additive response fields and enum values safely within v1.
</Note>