The below sections provide more exhaustive documentation of the core One Codex API, but first a note and a warning:


Source of Truth: Our API Schema

Our API is self-described using JSON Schema, with the root schema for the API available at While we do our best to keep this documentation accurate and up-to-date, in cases where there is a discrepancy between this documentation and the JSON schema, please defer to the API schema. However, we may occasionally offer features via the API that are explicitly not documented here – only documented features should be assumed to be stable.

Please let us know if you run into any issues by sending us a note or contacting us via the chat icon on the bottom right. Thanks!