API documentation
Publish an API reference from your OpenAPI spec beside your Help Center guides, with code samples, an interactive playground, versions, and AI-ready pages.
- API documentation overviewPublish an API reference from your OpenAPI spec beside your Help Center articles, with code samples, a Try it playground, versions, and AI-ready pages.
- Publishing an API reference from an OpenAPI specImport your OpenAPI spec, review the endpoints it creates, and publish them as an API reference in your Help Center.
- Organizing the API reference tabName the API reference tab, choose its start page, add guide sections beside the generated endpoint pages, and place the tab in your top bar.
- Code samples and the API playgroundChoose how readers test requests, which servers the playground may call, and which example languages appear on endpoint pages.
- Updating your API reference from a URL or CIKeep your published API reference in step with your API through automatic URL checks, pushes from your CI pipeline, or file uploads.
- Reviewing and publishing API changesReview a draft import, read the change list and warnings, publish, and roll back to an earlier revision when needed.
- Managing API versions and multiple APIsPublish several versions and several APIs in one Help Center, set the default version, and deprecate or archive old versions.
- API documentation FAQsFind answers about API documentation: supported spec formats, Try it, downloads, guide pages, endpoint intros, editing permissions, Fibi, and limits.