API reference overview

Pinnate generates an interactive API reference from a published OpenAPI document in your organization registry, and embeds it in a docs site section.

Flow

1. Register an API and publish a version

2. Add an embed in site.yaml or the console (api: your-slug)

3. Readers open /{sectionSlug} on your docs host

sections:
  - name: API
    slug: api
    api: payments

What readers get

• Operation navigation from the OpenAPI document

• Schemas and examples from the spec

• Try-it style exploration where the reference UI supports it

Guides stay Markdown; leave endpoint tables to the embed. See OpenAPI embed and SDK / CLI embeds.

Customization

Use api_layout on the embed section to reorder tags, hide tags/operations, flatten the nav, or hide Models. See Layout.