Help Center API Reference

Import an OpenAPI spec as a draft

Imports a new OpenAPI 3 spec into a version. The result is always a draft: nothing changes in the help center until you publish it. Auto-publish never applies here.

POST

/v2/help_center/api_specs/{specId}/import

curl --request POST \
  --url https://do.featurebase.app/v2/help_center/api_specs/{specId}/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "openapi: 3.1.0\ninfo:\n  title: Acme API\n  version: 1.0.0\npaths: {}\n",
  "url": "https://api.acme.com/openapi.json"
}
'

{
  "object": "help_center_api_spec_sync",
  "replayed": true,
  "sha256": "<string>",
  "status": "queued",
  "syncId": "0f7c3a1e-8d1b-4a53-9a51-3f7a1c9e2b4d"
}

Body

Send exactly one of:

url: an https URL of the raw JSON or YAML file. Featurebase fetches it once (the version keeps its source; use the dashboard to set a URL that is checked every 6 hours).
content: the JSON or YAML text. Up to 50 MB; for a big file url is easier.

Swagger 2.0 is rejected: convert it to OpenAPI 3 first. The same limits as the dashboard apply (50 MB, 1,000 tags, 5,000 endpoints).

Result

202 with a syncId. The spec is processed in the background: poll GET /v2/help_center/api_specs/{specId}/syncs/{syncId} until the status is draft, noop or failed, then read the draft (GET …/draft) and publish it.

Send an Idempotency-Key header to make retries safe (24 hours).

Limits

60 imports and syncs per hour per version, 120 per hour per API key. Every call is in the audit log.

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

contentstring

The OpenAPI 3 document as JSON or YAML text. Up to 50 MB; a big file is easier to import with url or the sync endpoint.

Minimum string length: 1

Example:

openapi: 3.1.0
info:
  title: Acme API
  version: 1.0.0
paths: {}

urlstring

An https URL of the raw OpenAPI 3 JSON or YAML file. Featurebase fetches it once.

Required string length: 1 - 2048

Example: https://api.acme.com/openapi.json

Response

Success

objectenum<string>required

Available options: help_center_api_spec_sync

Example: help_center_api_spec_sync

replayedboolean

True when the same Idempotency-Key returned the first import.

sha256string

SHA-256 of the stored spec bytes.

statusstringrequired

queued, or the first status on an idempotent replay.

Example: queued

syncIdstringrequired

Poll GET /v2/help_center/api_specs/{specId}/syncs/{syncId}.

Example: 0f7c3a1e-8d1b-4a53-9a51-3f7a1c9e2b4d

Still need help? Ask the team