API Overview#

This placeholder page introduces the HTTP API. Replace it with your real API reference content.

Base URL#

All API requests are made to a single base URL. Every endpoint described in these docs is relative to it.

https://api.example.com/v1

Versioning#

The API is versioned in the URL path. Breaking changes are only introduced in a new major version, and older versions remain available during a deprecation window.

Stability#

Endpoints are marked as either stable or beta. Beta endpoints may change without notice and should not be relied on in production.

Response format#

Every response is JSON and includes a top-level data field on success or an error field on failure. See Authentication to learn how to authorize requests, then browse the Endpoints.