Introduction

DevDocs is the hosted developer documentation system for teams that need reader-ready docs, preview-safe releases, domain operations, and API references that stay tied to the same publishing workflow.

The Core API describes the product model behind that system. It is REST-oriented, JSON-first, and organized around the objects a docs platform needs to operate clearly:

• site records define a docs hub, its source repository, and its public identity.
• source records describe where content comes from and how it is built.
• release records track preview, review, promotion, rollback, and production state.
• domain records connect readable hostnames to release-ready docs surfaces.
• api_reference records connect OpenAPI specifications to generated reference pages and playground behavior.
• audit_event records keep the operational trail visible when publishing, auth, or domain state changes.

Why this API exists

DevDocs is not just a static docs renderer. It is a product surface for managing documentation as software:

• writers need clean authoring primitives and stable previews
• reviewers need proof that a branch is ready before promotion
• operators need domains, releases, and exceptions in one place
• developers need OpenAPI references that can be explored, executed, and debugged
• AI systems need structured docs and machine-readable endpoints that reflect the same truth humans read

API shape

Examples in this section use the intended public API shape:

https://api.devdocs.ai/v1

Generated OpenAPI pages will become the source of truth as endpoints move from product model to shipped API. Until then, this Core API section documents the DevDocs vocabulary and interaction patterns that the playground work should reinforce.

Read next