Integration · Updated
OpenAPI integration for usedocs
API questions need exact answers: endpoints, parameters, and errors. Importing the OpenAPI file puts the reference in the same help center as your guides, so the assistant can cite it.
TL;DR
Short answer
Import an OpenAPI file in JSON, from its URL or pasted, and usedocs creates an API reference page for each endpoint in your help center, with its parameters and request and response fields. Review and publish them next to your guides, and the assistant answers API questions with a link to the right page. Sync again when the spec changes, and the same pages update.
Overview
Give usedocs the URL of your OpenAPI file, or paste it, and usedocs creates a page for each operation, grouped by tag or in one API reference collection. Review, publish, and the assistant can answer from them with a source link. Guides that explain authentication, pagination, webhooks, and errors live next to the reference; connect GitHub so merged pull requests propose edits to those guides when the code changes. Every page also has a Markdown copy and appears in llms.txt, and developers can install your docs in Cursor.
What this integration does
Reference articles
Draft articles per operation, grouped in an API reference collection.
Cited API answers
The assistant links the reference article behind each answer.
Next to your guides
Reference and guides in one help center with one search.
AI tool access
Markdown copies, llms.txt, and an MCP install for Cursor.
Setup
Open Import In Help center, open Import and choose OpenAPI.
Paste or upload the file JSON from a URL or pasted (convert YAML to JSON first); usedocs creates a page per endpoint.
Review and publish Check the drafts and publish the reference collection.
Re-import on changes Import again when the spec changes.
Limits and plan notes
- Very large specs import more slowly.
- Examples are only as good as those in the file.
- Keep private or beta endpoints out of a public help center, or put them in a private collection.
- Re-import is manual.
Not for you if
Skip this if you need an interactive API playground or SDK generation; keep those tools and import the reference only for answers and search.
FAQ
What does the OpenAPI import create?
Draft API reference articles for the operations in your file.
Which formats are supported?
OpenAPI 3.x or Swagger 2.0 files in JSON. Convert YAML to JSON first, for example with the Redocly CLI.
Does the assistant answer API questions?
Yes. It answers from the reference and guides with a link to the source.
How do I update the reference?
Import the file again when the spec changes.
Can partner endpoints stay private?
Yes. Put them in a collection limited to signed-in readers.
Do guides update when the API changes?
Connect GitHub and merged pull requests propose edits to the guides they affect. Re-import the file to refresh reference articles.