Help Center API Reference

Check the source URL now

Fetches the source URL of a version now (the same as "Check now" in the dashboard). Only for versions whose source is a URL.

POST

/v2/help_center/api_specs/{specId}/check_url

curl --request POST \
  --url https://do.featurebase.app/v2/help_center/api_specs/{specId}/check_url \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "object": "help_center_api_spec_url_check",
  "sha256": "<string>",
  "status": "queued"
}

queued (202): the file changed; a draft is being built. Retrieve the draft after a short wait.
unchanged (200): the file is the same as the live or the pending draft revision.

Limits: 20 checks per hour per version and 120 outbound checks per hour per organization.

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

Response

Success

objectenum<string>required

Available options: help_center_api_spec_url_check

Example: help_center_api_spec_url_check

sha256string

SHA-256 of the fetched file (when queued).

statusenum<string>required

queued: the file changed and a draft is being built (retrieve the draft later). unchanged: nothing new.

Available options: queued, unchanged

Example: queued

Still need help? Ask the team