Point us at the OpenAPI file you already have. You get the expanded reference, code examples in ten languages, and a playground that fires real requests, so a developer can call the endpoint on the page that explains it.
Guides and API references in one portal, under one search bar. The docs editor lives here →
OpenAPI 2, 3, 3.1 and 3.2, plus Swagger, in YAML or JSON. Everything arrives fully expanded, so nobody has to resolve a $ref in their head to work out what the response looks like.
Every operation ships with ready-to-copy examples built from your spec, with the auth header already filled in. Change the spec and every snippet changes with it, which is more than can be said for the ones pasted into your README in 2023.
There is no cap on API references. Host one per microservice, keep a reference per published version, and let readers move between them without leaving your docs. Very large definitions load fine.
The playground sits on the reference page itself. Headers, parameters and OAuth flows come pre-populated from your spec, the response comes back with its status and timing, and nobody has to open Postman to find out what a 422 looks like.
A reader pastes their own API key once. Every playground call and every code sample on every page then uses it, so the snippet they copy is the snippet that works.
Authorisation code, client credentials, PKCE and plain Bearer. The playground runs the flow rather than describing it in a paragraph nobody reads.
Most OpenAPI editors make you choose: a friendly form that hides half the spec, or raw YAML with a linter that shouts after the fact. This is the same document in Visual, Split and Source, linted live in every one.
Fill in a form if you want one, drop into YAML when you need to, or keep both open side by side. Errors and warnings appear as you type, and clicking an issue takes you to the exact line that caused it.
An API reference is out of date the moment someone merges. Push the spec from your pipeline, sync the repo both ways, and let the changelog explain what changed, drafted from the diff rather than from memory.
Post the OpenAPI definition to our API on every build. Readers get the new version the moment the build goes green, with no manual upload and nobody remembering to do it on release day.
Keep the OpenAPI file and the written pages under version control and push a commit. Sync runs both ways, on every branch, every pull request and every release, and the checks run before anything merges.
Our AI agents cover the reference as well as the guides. The OpenAPI AI Agent works on the specification behind your reference, and like every agent here it drafts rather than publishes: you read the changeset before a reader sees any of it.
How our AI agents work →Native changelogs with an RSS feed, so integrators can subscribe to your breaking changes instead of discovering them in production. The agent drafts each entry from the diff between spec versions, including the deprecations you would have forgotten.
Every OpenAPI definition loads, however large it has grown. Render it as a single scrolling reference when it is small enough to skim, or give each operation its own page when it is not.
Most companies run the tutorial on one platform and the reference on another, and readers pay for it. Here they are the same portal: deep-link any operation from any guide, and search once across both.
Semantic search across endpoints, parameters and descriptions.
Readers add their key once; every call and snippet updates.
Full OAS 3.1 and 3.2 support, rendered properly.
See which endpoints developers cannot find, then fix it.
Gate internal references behind SSO, magic links or JWT.
Respects the system preference, out of the box.
Your logo, colours, fonts and domain. No DeveloperHub branding.
Fetch pages, run searches and embed docs inside your product.
“We have APIs and SDKs which we monetise through and they need to be explained. My dream is to have them self-serviced, but in order to make them self-serviced, we need to empower our client with the ability to easily integrate.”
Import the OpenAPI file you already have and look at the reference it produces. Fourteen days free, no card, no sales call unless you want one.
