SDK & Frameworks

Help Center API

Read your published Help Center articles from your own site, and write and publish articles from your code, a script or a coding agent

Your Help Center has a REST API at https://api.futurebase.io/v1/help-center. It does two things:

  • Read your published articles and collections, with no token, so you can show your help center on your own site in your own design.
  • Write articles and collections with an API token: create drafts, update them, publish, unpublish and delete. Use it to keep articles in step with your product from a script or your CI.

Every article you publish through the API is the same as one published in the dashboard: it goes on your help site and your agent answers from it and links to it.

Coding agents such as Claude Code and Cursor can do the same through MCP tools.

Read your help center

The read endpoints are public. They need no token, return published articles only (drafts never appear), work from any website (CORS is open) and answer only while your help center is on. Your help center's address, the HANDLE in the examples, is the last part of futurebase.io/help/<handle>.

Your help center and its collections

curl https://api.futurebase.io/v1/help-center/HANDLE
{
  "helpCenter": {
    "agentId": "YOUR_AGENT_ID",
    "handle": "lumen",
    "name": "Lumen Help",
    "tagline": "Answers for riders",
    "language": "en",
    "primaryColor": "#2563EB",
    "logoUrl": "https://api.futurebase.io/v1/help-assets/help-center/…/logo.png",
    "brandName": "Lumen",
    "headerLinks": [{ "label": "Back to lumen.bike", "url": "https://lumen.bike" }],
    "askAgentEnabled": true,
    "indexable": true,
    "url": "https://www.futurebase.io/help/lumen",
    "searchUrl": "https://www.futurebase.io/help/lumen/search",
    "articleCount": 24,
    "updatedAt": "2026-11-03T08:12:00.000Z"
  },
  "collections": [
    {
      "id": "0193…",
      "slug": "orders-shipping",
      "name": "Orders & shipping",
      "description": "Tracking, delivery and returns",
      "icon": "package",
      "url": "https://www.futurebase.io/help/lumen/collections/orders-shipping",
      "articleCount": 9,
      "children": []
    }
  ]
}

Collections come in their order, with the collections inside them under children. Collections without published articles are left out, and a collection's articleCount includes its children's.

List articles

curl "https://api.futurebase.io/v1/help-center/HANDLE/articles?collection=orders-shipping&limit=50"
{
  "collection": { "id": "0193…", "slug": "orders-shipping", "name": "Orders & shipping" },
  "articles": [
    {
      "id": "0193…",
      "slug": "return-a-bike",
      "title": "Return a bike within 30 days",
      "excerpt": "You can return any bike within 30 days of delivery.",
      "url": "https://www.futurebase.io/help/lumen/articles/return-a-bike",
      "collectionId": "0193…",
      "updatedAt": "2026-11-02T09:30:00.000Z"
    }
  ],
  "nextCursor": null
}
ParameterWhat it does
collectionA collection's slug. Lists that collection's own articles in their order (not the ones in the collections inside it). Without it, every published article is listed, most recently updated first.
limitArticles per page, 1 to 100. Default 50.
cursorThe nextCursor of the previous page. nextCursor is null on the last page.
qSearches instead: see below.

Add q to search titles, excerpts and bodies. It matches the start of words, so ret finds "return". You get up to 20 results, best first, without paging, and each one adds the collection's name and a snippet around the match:

curl "https://api.futurebase.io/v1/help-center/HANDLE/articles?q=return"
{
  "collection": null,
  "query": "return",
  "articles": [
    {
      "id": "0193…",
      "slug": "return-a-bike",
      "title": "Return a bike within 30 days",
      "excerpt": "You can return any bike within 30 days of delivery.",
      "url": "https://www.futurebase.io/help/lumen/articles/return-a-bike",
      "collectionId": "0193…",
      "updatedAt": "2026-11-02T09:30:00.000Z",
      "collectionName": "Orders & shipping",
      "snippet": [
        { "text": "You can ", "highlight": false },
        { "text": "return", "highlight": true },
        { "text": " any bike within 30 days of delivery.", "highlight": false }
      ]
    }
  ],
  "nextCursor": null
}

The snippet is plain text. Show the parts with "highlight": true in bold or with a <mark>. Add collection to search inside one collection.

Get an article

curl https://api.futurebase.io/v1/help-center/HANDLE/articles/return-a-bike
{
  "article": {
    "id": "0193…",
    "slug": "return-a-bike",
    "title": "Return a bike within 30 days",
    "body": "## Before you start\n\nPack the bike in its original box…",
    "html": "<h2 id=\"before-you-start\">Before you start</h2>\n<p>Pack the bike in its original box…</p>",
    "excerpt": "You can return any bike within 30 days of delivery.",
    "seoTitle": null,
    "seoDescription": null,
    "url": "https://www.futurebase.io/help/lumen/articles/return-a-bike",
    "publishedAt": "2026-10-28T14:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "outline": [{ "id": "before-you-start", "text": "Before you start", "depth": 2 }]
  },
  "collection": {
    "name": "Orders & shipping",
    "url": "https://www.futurebase.io/help/lumen/collections/orders-shipping"
  },
  "breadcrumbs": [
    { "name": "Lumen Help", "url": "https://www.futurebase.io/help/lumen" },
    { "name": "Orders & shipping", "url": "https://www.futurebase.io/help/lumen/collections/orders-shipping" }
  ],
  "related": []
}
  • body is the article in Markdown. html is the same article as your help site shows it: raw HTML and unsafe links are removed, and every H2 and H3 has the id its outline entry links to, so you can build a table of contents.
  • updatedAt is the last change to the title, body or excerpt.
  • related lists up to a few articles from the same collection, shaped like the list above.

Moved articles and addresses

When you change an article's URL or your help center's address, the old one keeps working: the API answers 308 with a Location header pointing at the new path, for example /v1/help-center/lumen/articles/return-a-bike. fetch and curl -L follow it for you. If you render your own pages, redirect your old page to the new slug too.

Caching and limits

Each IP address can make 120 read calls a minute, and 60 searches a minute per help center. Successful answers carry Cache-Control: public, max-age=60; your help site refreshes as often.

Write articles

Writing with the API is on the Standard plan and up.

Get a token

Open Help Center → Settings and, under API, create a token. It has the Write and publish Help Center articles permission (help_center:write). Any member of your team can create one. Copy it right away: it's shown only once.

Keep the token on your server or in your CI secrets, for example as FUTUREBASE_API_TOKEN. It acts as you, so treat it like a password, and never put it in a web page. Tokens last a year; revoke one on the same page.

Every call sends it as a bearer token, Authorization: Bearer fbx_…, and names the agent with agentId, in the JSON body or the query string. Your agent's ID is the data-wid from your install snippet.

Writes go through the same steps as the dashboard: URLs are made from titles, your plan's published-article limit applies, and each change is made as the token's owner. A token stops working if its owner leaves your organization.

Create a draft

curl -X POST https://api.futurebase.io/v1/help-center/articles \
  -H "Authorization: Bearer $FUTUREBASE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "YOUR_AGENT_ID",
    "title": "Return a bike within 30 days",
    "body": "## Before you start\n\nPack the bike in its original box.",
    "collectionId": "COLLECTION_ID"
  }'

The answer is 201 with the new draft: { "article": … }. Every field is optional:

FieldWhat it is
titleUp to 200 characters. An article needs one before it can be published.
bodyMarkdown, up to 200,000 characters. Start sections with ##; the title is the page's heading.
excerptThe summary in lists and search results, up to 300 characters. Without one, the first lines are used.
slugThe article's URL. Made from the title unless you send one (lowercase letters, numbers and dashes).
collectionIdThe collection it goes in, or null for none.
seoTitle, seoDescriptionWhat search engines show, up to 70 and 160 characters.

An unknown field is an error (400), so a typo never goes unnoticed.

An article looks like this:

{
  "id": "0193…",
  "agentId": "YOUR_AGENT_ID",
  "slug": "return-a-bike-within-30-days",
  "title": "Return a bike within 30 days",
  "body": "## Before you start\n\nPack the bike in its original box.",
  "excerpt": null,
  "seoTitle": null,
  "seoDescription": null,
  "status": "draft",
  "collection": { "id": "0193…", "name": "Orders & shipping", "slug": "orders-shipping" },
  "url": null,
  "agentUses": null,
  "createdAt": "2026-11-03T10:00:00.000Z",
  "updatedAt": "2026-11-03T10:00:00.000Z",
  "contentUpdatedAt": "2026-11-03T10:00:00.000Z",
  "publishedAt": null
}

url is the public page while the article is published and your help center is on. agentUses says whether your agent answers from it (null for drafts).

Publish and unpublish

curl -X POST https://api.futurebase.io/v1/help-center/articles/ARTICLE_ID/publish \
  -H "Authorization: Bearer $FUTUREBASE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "agentId": "YOUR_AGENT_ID" }'

Publishing puts the article on your help site and in your agent's knowledge; your agent answers from it within a minute or two. Past your plan's published-article limit the answer is 403 with a message that says so, and the article stays a draft.

POST /v1/help-center/articles/ARTICLE_ID/unpublish takes it off your help site and out of your agent's answers. It stays as a draft.

Update an article

curl -X PATCH https://api.futurebase.io/v1/help-center/articles/ARTICLE_ID \
  -H "Authorization: Bearer $FUTUREBASE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "YOUR_AGENT_ID",
    "body": "## Before you start\n\nPack the bike in its original box or a sturdy one.",
    "expectedUpdatedAt": "2026-11-03T10:00:00.000Z"
  }'

Send only the fields you change. Changing a published article changes the live page and what your agent answers right away.

expectedUpdatedAt is optional: send the updatedAt you last read, and the call fails with 409 if someone changed the article since, so you never overwrite a teammate's edit. Without it, your change wins.

List, read and delete

CallWhat it does
GET /v1/help-center/articles?agentId=…Your articles, drafts included, most recently changed first: { "articles": […], "nextCursor": …, "total": … }. Filter with status (draft or published), collectionId (none for articles in no collection) and q (text in the title or body); page with limit (up to 100) and cursor.
GET /v1/help-center/articles/ARTICLE_ID?agentId=…One article: { "article": … }.
DELETE /v1/help-center/articles/ARTICLE_ID?agentId=…Deletes the article and takes it out of your agent's answers: { "deleted": true, "id": … }. It can't be undone.

Collections

curl -X POST https://api.futurebase.io/v1/help-center/collections \
  -H "Authorization: Bearer $FUTUREBASE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "agentId": "YOUR_AGENT_ID", "name": "Billing", "description": "Plans, invoices and refunds" }'

The answer is 201 with { "collection": … }. Add parentId to put it inside another collection (one level deep), icon for one of the icons the dashboard offers, and slug to choose its URL.

GET /v1/help-center/collections?agentId=… lists your collections in order, each with articleCount (drafts included), publishedCount and its children.

Errors and limits

Errors are JSON: { "error": "A readable message", "code": "BAD_REQUEST" }.

StatusWhen
400The body or a value is invalid, or agentId is missing; the message says which
401The token is missing, expired or revoked
403The token lacks help_center:write, its owner left the organization, the plan doesn't include the API, or publishing would go past the plan's limit
404The agent, article or collection wasn't found
409Another article or collection already uses this URL, or the article changed since expectedUpdatedAt
413The body is over 1 MB
429Too many calls; wait for the number of seconds in Retry-After

Each token can make 120 calls a minute.

MCP tools

The MCP Knowledge Base server lets a coding agent keep your help center in step with the code it ships. Next to getInformation, it has three tools for the agent the server is turned on for:

ToolWhat it does
list_help_articlesLists articles, drafts included, most recently changed first. Optional status (draft or published), collection (an id or slug, or none), q and limit (up to 100).
get_help_articleOne article with its Markdown body, by id or slug.
save_help_articleCreates an article, or changes one when you pass its id. Takes title, body (Markdown), and optionally collection (an id or slug), excerpt and publish.

save_help_article saves a draft unless you pass publish: true, so your team reviews the article in the dashboard first; every answer includes an editUrl that opens it there. A published article only changes with publish: true, because its page is live and your agent answers from it. If your plan's limit stops a publish, the article is saved as a draft and the answer says why.

Saving is on the Standard plan and up; listing and reading are not limited to it.

Plans

FreeHobbyStandardPro
Read published articlesYesYesYesYes
Write with the API and save_help_articleNoNoYesYes
Published articles101001,00010,000

On this page