Use cases · API documentation

API documentation your developers can read at a glance

Write API documentation in the help center your customers already use. An API endpoint block, highlighted code and generated samples give your developer documentation one clear shape.

An API endpoint block per endpoint
Request samples in four languages, generated
Markdown, llms.txt and MCP for AI tools
Start free trial Request a demo

14-day free trial · No credit card required

Path parameters detected for you
The problem

Why developer documentation drifts

Most API documentation starts as a README, a wiki page or a shared document. Every writer formats a request differently, code samples are pasted by hand and fall behind the API they describe, and nobody is sure which page is current. Developers send the wrong header, hit an error the docs never mention, and open a ticket or abandon the integration.

A separate API documentation tool fixes the formatting and doubles the work: another tool to host, another login, another search box, and guides in one place with the reference in another. Support answers questions the docs should have answered, and only engineers can edit them. The result is API docs that look different on every page and fall out of date with the next release.

The checklist

What good API docs include

Seven parts developers look for, and what covers each.

  • Authentication

    Where to send a key.

    Bearer token or API key header, set in each endpoint block.

  • Quickstart

    A first successful request.

    An article with code blocks and one endpoint block.

  • Endpoints

    Method, path, parameters, responses.

    One API endpoint block per endpoint, {path} parameters detected.

  • Errors

    Each status code, explained.

    Responses with a status code, a description and a JSON example.

  • Rate limits

    Limits and retry advice.

    An article with a table and a retry snippet.

  • Pagination

    Walking a long list.

    Typed query parameters, plus a code block for the loop.

  • Code samples

    Requests to copy.

    cURL, JavaScript, PHP and Python samples generated per endpoint.

API endpoint block

One block that keeps every endpoint consistent

Type / in the editor, choose API endpoint and fill in a form. Pick GET, POST, PUT, PATCH or DELETE, enter the base URL and path, and {path} parameters are detected for you. Authentication is a Bearer token, an API key in a header you name, or none.

Headers take a name, an example, a required flag and a description; query parameters add a type: string, integer, boolean or array. The body is a JSON example or form-data fields, and responses carry a status code, a description and a JSON example. cURL, JavaScript, PHP and Python samples are generated.

Available on every plan
Insert menu › Developer › API endpoint
Language detected, or pick one
Code blocks

Syntax-highlighted code for everything else

Not every snippet belongs to an endpoint. Code blocks hold SDK setup, webhook payloads and config files. Leave the language on auto and it is detected, or pick one: Bash, JavaScript, TypeScript, JSON, PHP, Python, Go, Ruby, SQL and YAML are all on the list, among others.

Inline code keeps parameter names, header values and file paths readable mid-sentence. Code blocks sit in the same rich editor as tables, callouts and images, so a guide and its snippets live in one article.

Available on every plan How to add code blocks
Docs at /docs

Host your API docs at yoursite.com/docs

Developers expect docs on your main domain. Subfolder hosting serves your help center from a folder of your own website, like www.yoursite.com/docs, through one proxy rule on your web server or CDN. A setup check tests it end to end before you switch, and old links redirect.

Prefer a subdomain? Every plan can use a custom domain like docs.yoursite.com, with SSL and a global CDN.

Subfolder hosting: Available on Growth and Catalyst Custom domain, SSL and CDN: Available on every plan
Host your help center in a subfolder How subfolder hosting works
Served from your own website
Read-only /mcp on every help center
AI coding tools

Developer documentation AI coding assistants can read

Coding assistants read documentation too. Every page serves clean Markdown at the same URL, and llms.txt lists your public articles, so AI tools read your API documentation cleanly.

Every help center also runs a read-only MCP server at its own /mcp address, so assistants such as Claude can search and fetch your articles live. For agents that also write, the authenticated MCP server at mcp.helpcenter.io connects with OAuth or an API key.

Markdown, llms.txt and read-only /mcp: Available on every plan Authenticated MCP: Available on Growth and Catalyst
See the MCP server
Beta endpoints

Keep beta endpoints private until they ship

Put beta endpoints in their own category and share it with team members only while you build, or with everybody who has the link, kept out of your navigation, so invited testers can read it. When the endpoint ships, share it with everybody.

Version history shows what changed, who changed it and when, and restores an earlier version if a release rolls back. How far back it goes depends on your plan.

Private and link-only content: Available on Growth and Catalyst Version history: Available on every plan
How version history works
Hidden from navigation until launch
Quick start

Set up your API docs in three steps

  1. Create your docs site

    Start a trial, pick a template and connect docs.yoursite.com.

    Use your own domain

  2. Write the reference

    Add an API endpoint block per endpoint, and code blocks for guides.

    Add code blocks

  3. Publish where developers look

    Publish on your domain, or at yoursite.com/docs on Growth and Catalyst.

    Host it in a subfolder

Moving existing docs? We migrate them for you, free, on every plan.

Live example

Our own API documentation runs on HelpCenter.io

developers.helpcenter.io is our public API documentation, and it is a HelpCenter.io help center like yours. It has the pages this checklist recommends, including a quickstart and pages on errors, rate limits and pagination, with an API endpoint block for each endpoint. Open it to see how the blocks, samples and navigation read before you build your own.

Starting from scratch? Copy the example structure shown here: one category per part, from the first request to the last page of results. Rename or reorder them as your API grows.

Available on every plan Visit developers.helpcenter.io
An example structure to copy
Plan fit

Which plan fits your API docs

Bootstrap

$29/mo billed annually, or $39 monthly

For a public API reference one person writes.

  • Code blocks and API endpoint blocks
  • Custom domain, SSL and a global CDN
  • Markdown, llms.txt and a read-only /mcp
  • Version history, one language, one team member

Growth

$119/mo billed annually, or $149 monthly

For docs with beta sections, /docs and a team.

  • Everything in Bootstrap
  • Private and link-only content
  • Subfolder hosting at yoursite.com/docs
  • Multiple languages, 10 team members
  • Authenticated MCP at mcp.helpcenter.io

Catalyst

$179/mo billed annually, or $199 monthly

For API docs with AI answers and design help.

  • Everything in Growth
  • Semantic search and AI answers included
  • 3 hours of manual customization
  • Unlimited team members

Search is typo-tolerant on every plan. Semantic search is included on Catalyst and is an add-on on Bootstrap and Growth. Compare every plan

FAQ

API documentation questions

Can I document REST endpoints?
Yes. Add an API endpoint block per endpoint with its method, path, authentication, parameters, body and responses. It generates cURL, JavaScript, PHP and Python samples, on every plan.
Which languages are highlighted?
Code blocks detect the language, or you pick one, such as Bash, JavaScript, JSON, PHP, Python or YAML. Endpoint samples are highlighted too.
Can I host docs at /docs?
Yes, on Growth and Catalyst, with one proxy rule on your web server or CDN. Every plan can use a custom domain like docs.yoursite.com, with SSL.
Can I keep beta endpoints private?
Yes, on Growth and Catalyst. Share the beta category with team members only, or with anyone who has the link, until launch.
Can AI coding assistants read my docs?
Yes. Every page serves Markdown, llms.txt lists your articles, and every help center has a read-only /mcp, on every plan. The authenticated MCP at mcp.helpcenter.io is on Growth and Catalyst.

Other questions? Talk to us.

Give developers API docs they can trust

Start a free trial and document your first endpoint today.

Start your 14-day free trial Request a demo

No credit card required · Free migration on every plan

Keep reading

Related reading