Help Center API Reference

Create or replace an endpoint intro

Creates or replaces the intro of one endpoint, keyed by stableKey (method + path, each path parameter written as {}, for example GET /posts/{}). Find the stableKey with GET …/endpoints.

PUT

/v2/help_center/api_specs/{specId}/intros

curl --request PUT \
  --url https://do.featurebase.app/v2/help_center/api_specs/{specId}/intros \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "## Before you start\n\nYou need an API key with the `posts:write` scope.",
  "formatter": "default",
  "operationId": "createPost",
  "stableKey": "GET /posts/{}"
}
'

{
  "body": "<p>You need an API key.</p>",
  "object": "help_center_api_intro",
  "operationId": "listPosts",
  "orphaned": false,
  "stableKey": "GET /posts/{}",
  "updatedAt": "2026-10-01T12:00:00.000Z"
}

body is Markdown or HTML, like an article body: it is converted to the help center format and sanitized (formatter: "raw" stores Featurebase HTML as it is, only sanitized). Max 1 MB after conversion.

Send operationId so the intro follows the endpoint when its path changes.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

specIdstringrequired

The API reference version (id from the list).

Example: 66f7d0c1a2b3c4d5e6f70812

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Body

bodystringrequired

The intro content: Markdown or HTML (like an article body). It is converted to the help center format and sanitized. Max 1 MB after conversion.

Maximum string length: 2097152

Example:

## Before you start

You need an API key with the `posts:write` scope.

formatterenum<string>

default: convert Markdown or HTML to the help center format. raw: store Featurebase HTML as it is (only sanitized).

Available options: default, raw

Example: default

operationIdstring

The endpoint operationId. When the path of the endpoint changes later, the intro moves with it.

Maximum string length: 256

Example: createPost

stableKeystringrequired

The endpoint key: HTTP method + path, each path parameter written as {}.

Required string length: 3 - 2048

Pattern: ^[A-Z]+ \S+$

Example: GET /posts/{}

Response

Success

bodystringrequired

The intro HTML (help center format).

Example: <p>You need an API key.</p>

objectenum<string>required

Available options: help_center_api_intro

Example: help_center_api_intro

operationIdstring | nullrequired

Example: listPosts

orphanedbooleanrequired

The endpoint is no longer in the live spec. The intro is kept.

Example: false

stableKeystringrequired

Example: GET /posts/{}

updatedAtstring | nullrequired

When the intro was last saved.

Example: 2026-10-01T12:00:00.000Z

Still need help? Ask the team