Skip to content
Developer docs
Docs menu

API reference

Markdown

This reference is generated from the OpenAPI document. Endpoints marked Coming soon do not exist yet, are not a stable contract, and may change before launch. Endpoints marked Deployment option are optional: where a deployment does not enable them, they return 404.

Base URLhttps://api.mirabase.dev
OpenAPIhttps://api.mirabase.dev/v2/openapi.yaml
Spec version2.0.0 (33c172f77f2c)
Status115 implemented by default, 12 implemented as a deployment option, 3 coming soon

Common headers

Every endpoint accepts the headers below. Authenticated responses carry RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset: see Rate limits and quotas. The rules for pagination, idempotency, conditional requests, jobs, and errors are in API conventions, and every error code is listed in Error codes.

FieldTypeDescription
Mirabase-Contract-VersionstringExplicit contract version to negotiate. Omit to use the current compatible contract.
X-Request-IdstringCaller correlation id. The service replaces an invalid value with one it issues.

Endpoint groups