Ellie Help
Ellie Help Home What's new Getting started9 Work with Ellie4 Write and organise content7 Keep your docs up to date1 Publish and brand3 Walkthrough videos2 Changelog2 Measure and improve1
API reference1
Workspace and billing6 Connect AI tools1 Security and data3 Troubleshooting1
Powered by Ellie Docs
API reference/Publish an API reference

Publish an API reference

Updated 30 Oct 2026

On this page

Publish a developer-facing API reference on your help centre, then decide which endpoints customers can see. This is for teams on Growth or Scale who want Ellie to generate API docs from code or ingest an OpenAPI spec.

Step by step

  1. Open your project, then go to API Reference.
  2. If your project has no API reference yet, click Generate from code.
    The API Reference page offering Generate from code
  3. Prefer to use an OpenAPI spec? Go to Project → Settings → Product → Doc spaces, find API Reference, enter a URL in https://your-app.com/openapi.json (optional) if needed, then click Enable developer docs. Or, if API Reference shows Already have an OpenAPI spec? Paste a URL instead, enter your spec URL and click Ingest.
  4. Open API Reference again after enabling.
  5. Review each operation and set its visibility to Public, Internal, or Excluded.
  6. Change every endpoint you want customers to see to Public.
  7. Click View API reference to open the published API reference on your help centre.

Good to know

What happens after I enable API Reference? Ellie ingests your operations and starts writing guides. After enabling from settings, you’ll see: API Reference enabled — N operations ingested. Guides are being written now; see the API Reference page.

What does Generate from code do? It builds the reference from your code’s routes. New operations start as Internal, so review the list and change customer-facing endpoints to Public before they appear in your published API reference on the help centre.

What do I review on the API Reference page? Operations are grouped by tag. Each row shows the method chip, path, summary, and a visibility control with Public, Internal, or Excluded. Only Public operations appear in the published API reference.

Can I update the API reference later? Yes. Use Re-generate for code-derived references or Re-ingest spec for spec-based references. Re-running updates narrative and examples only for operations whose contract changed.

Why can’t I enable API Reference? API Reference is included on Growth and Scale. On other plans, enabling is blocked and the message starts with The API reference needs the Growth plan. You can review plan options in Settings → Billing.

What if my spec URL does not work? The URL must be a publicly reachable http or https address. If Ellie cannot fetch it, you’ll see an error banner such as could not fetch <url>: HTTP 404.

Recent updates

All updates →
On this page