Use the API reference section in the sidebar to browse operations, request and response shapes, and try calls in the interactive playground.
The COSMIC API layer is in public preview. Endpoint structure is expected to be mostly stable, but response fields, edge cases, and reliability are still subject to change.
Base URL
API requests use this host:
Paths in the reference (for example /v1/me) are appended to that base URL.
Authentication
Send a valid access token in the Authorization header as a Bearer token:
Most /v1/* operations require authentication. OAuth app tokens are limited by the scopes you enable for the app. See Access tokens, Scopes, and Authorization.
OpenAPI specification
Download the machine-readable API description (OpenAPI 3) to generate clients, validate requests, or import into your own tools:
