Knowledge base API overview

The knowledge base API lets you programmatically access and manage your Fernand help articles and collections. It’s designed to make it easy to fetch the structure of your knowledge base, retrieve individual articles, or update their content and organization without touching the app’s UI. With this API, you can build your own documentation frontends, sync articles to a static site, or automate editorial workflows.

Base URL

All requests are made against the Fernand API base URL:

https://api.getfernand.com/knowledge/structure

Authentication

Every request must include your API key passed through the X-Api-Key header. Keys can be generated from your Fernand dashboard. Keep them secret and never expose them in public client-side code.

curl -H "X-Api-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ https://api.getfernand.com/knowledge/structure

Endpoints

The knowledge base API includes a few core endpoints:

  • GET /knowledge/structure
    Returns the full set of articles and collections

  • GET /knowledge/articles/{id}
    Fetches a single article, including HTML content

  • GET /knowledge/collections/{id}
    Fetches metadata and articles inside a collection

  • POST /knowledge/articles/
    Create a new article

  • POST /knowledge/collections/
    Create a new collection

  • PATCH /knowledge/articles/{id}
    Update fields of an article

  • PATCH /knowledge/collections/{id}
    Update fields of a collection

  • DELETE /knowledge/articles/{id}
    Delete an article

  • DELETE /knowledge/collections/{id}
    Delete a collection

Data format

All responses are JSON. Articles include fields such as id, title, slug, content, published, and timestamps. Collections include id, title, slug, and a list of associated article IDs. For more details, see the dedicated pages for articles and collections.

Rate limits and errors

The knowledge base API follows Fernand’s global rate limiting rules. Standard HTTP error codes are used to indicate problems (such as 401 Unauthorized for missing or invalid API keys, 404 Not Found for missing resources, and 409 Conflict for slug collisions when updating).

Next steps

Start with Fetching the knowledge base structure to learn how to query your entire KB. Then explore the articles and collections pages to understand how to retrieve and update specific content.

Was this helpful?