Back to overview

Documentation approach

The API reference will derive from OpenAPI.

Magellan does not have a published OpenAPI definition yet. The future API reference will be generated from a reviewed, versioned definition so implementation and documentation share one contract.

Documentation will be gated behind an authenticated Magellan account when access opens. Public marketing pages will not become a shadow source of protocol behavior, limits, or security guarantees.

Publication rules

One contract, explicit status, controlled access.

01

Generated, not duplicated

Reference pages follow the versioned OpenAPI source.

02

Status on every surface

Planned, preview, and available behavior remain distinguishable.

03

Authenticated access

Operational and security details stay behind account access.