OpenAPI Specs
An OpenAPI document keeps an API specification — OpenAPI or Swagger, in YAML or JSON — in the same project as your ERDs, diagrams, and Markdown documents. You bring the spec; AI-ERD stores it exactly as written, renders it, and turns it into downloadable docs. There is no AI generation step, so it uses no credits.
Create an OpenAPI document
- Open File > New Document or click the project/folder new-document action.
- Choose the target project and, if needed, a folder.
- Select OpenAPI as the document type.
- Enter a title and create the document.
A new document is empty. Switch to Source and paste your spec.
Preview and Source
The header shows the spec's OpenAPI version, format, and how many paths and operations it has. Two modes:
| Mode | What it does |
|---|---|
| Preview | Renders the spec as interactive API documentation. It is read-only: there is no "Try it out", so opening a spec never sends requests to the servers it lists. |
| Source | The raw spec text, with Check and Save. |
In Source:
- Check validates the spec without saving it.
- Save stores it only if it passes the same check. If it does not, every problem is listed and nothing is saved.
- The text is stored exactly as written — never reformatted.
- A spec can be up to 1 MiB.
- If someone else saved the spec after you started editing, saving stops and asks you to reload and reapply your change.
Documents shared with you as read-only can be previewed but not edited.
Endpoints panel
Open Endpoints in the right rail for a list of every operation (method, path, summary). Click one to scroll the preview to it. The right rail also has Share.
Download
| Button | You get |
|---|---|
| Download source | The spec file as stored (.yaml or .json) |
| Download docs (MD) | Markdown API docs generated from the spec on the server |
| Download PDF | The same docs as a PDF, generated on the server |
The MD and PDF downloads work from either mode.
Public sharing
Anyone with a public link can view the rendered spec and download the source file without signing in. The generated MD and PDF docs require signing in — a visitor who is not signed in is asked to log in or create a free account first.
Using OpenAPI documents from MCP
Create an OpenAPI document with create_documents (type openapi), passing the spec text in typePayload.content. list_documents and get_document work on them as on other document types. See the MCP Tool Reference.