Publishing help

Publish your first site

1. On the homepage, choose a self-contained OpenAPI 3.0 or 3.1 JSON or YAML file, up to 10 MiB. Review the reference in your browser.
2. Select Save to workspace and sign in. For a new site, review the suggested name and address. Select Import file to save the original and build your draft.
3. Add a Markdown guide if you need one. Save the draft, open its preview, then select Publish. Use View site to open the reader link.

Update a source

Import a replacement file from the editor, or choose an HTTPS source URL and refresh it. For a connected GitHub repository, choose one branch and file. A changed source updates the API draft. Your guides and the published version stay available while you review it.

For an invalid import, use the field path and line number in the import history to locate the problem. Bundle external references into one file. When a temporary failure offers Retry import, wait for the retry button to become available.

Review, roll back and export

Publishing captures the saved source, guides and appearance together. If another editor saves during a build, their changes stay in the newer draft. Use the release history to restore a retained snapshot. The current address and access settings continue to apply.

Workspace Owners and Editors can export a saved draft, the current publication or a retained release from the editor. The export uses the version you selected, even if someone edits the draft while it is being prepared. The download starts after the files have been checked. Sign in again if your session has expired.

Unzip the archive to read the guides, original OpenAPI and referenced attachments offline. Readers can download the published OpenAPI and open individual pages in Markdown.

Reader access and Try-it

The workspace Owner can configure a site password on Pro. Once unlocked, readers can search, read Markdown and download files from that release. Markdown indexes are available at llms.txt and llms-full.txt under the reader site.

Try-it sends a request from the reader’s browser when they select Send. Check the method and destination first. The target API must allow this reader origin through CORS and support HTTPS when the documentation uses HTTPS. A blocked request offers a cURL template.

For a callback or webhook, open Events. Enter a receiver you control, choose the declared content type, and send a test. Form fields and files go directly to that receiver. A draft preview lets you inspect the contract before publishing.

Orders and paid access

Compare Free and Pro

Open the workspace’s Billing page to see its plan, paid-through date and orders. When PayPal checkout is available, the page shows the price, currency and access period. Each purchase requires approval. HuiAPI activates paid time after verifying the capture.

If a return from PayPal leaves an order pending, use Check payment before creating another order. An Owner can close an eligible unpaid order. A verified full reversal removes that purchase’s grant, and a partial refund or dispute goes to review.