Overview

Each OpenAPI spec you import is one version of an API, such as v1 and v2. You can publish several versions side by side, choose the default version that readers open first, and deprecate or archive old versions. You can also publish more than one API in one Help Center, each with its own versions and tab.

You manage versions under Settings → Help Center → API reference. Each row in the list is one version, with labels such as Default, Deprecated, or Archived.

How versions work

Name and version label

Each version has a Name, the API name readers see, and a Version label, shown in the version switcher. Both come from info.title and info.version in the spec when you import it. To change them, open the version's Settings tab and edit them under Version. Each version needs its own label.

The default version

Each API has its own default version, the one readers see first when they open that API. The first version you publish in an API becomes its default.

Fibi AI Agent and your Help Center's llms.txt use the default version of each API. Help Center search covers the default version of each API and the version the reader is viewing.

What readers see

With two or more published versions of an API, readers switch between them in a menu at the top of its sidebar. The menu lists only the versions of that API. Switching keeps readers on the same endpoint when it exists in the other version. Otherwise, they land on that version's overview.

Add a new version

1. Go to Settings → Help Center → API reference

2. Click 'Add API spec'

3. Import the spec of the new version from a file, a URL, or CI

4. Review the endpoints and click 'Publish N pages'

The new version does not replace the API's current default. If its label matches an existing version, Featurebase adds a number, such as 2.0-2. Rename it in the version's Settings tab. Publishing an API reference from an OpenAPI spec covers each import option.

Set the default version

Open the version and use either control:

• In the version's ••• menu, click 'Make default'

• In the version's Settings tab, turn on Default version

Only a published version that is not archived can be the default. Changing the default of one API does not affect your other APIs.

Deprecate or archive a version

Open the version's ••• menu and choose:

• 'Mark deprecated': Keeps the pages online with a deprecation banner

• 'Archive': Takes the version out of your Help Center and redirects its links

• 'Mark active': Undoes either one

The default version cannot be deprecated or archived. Make another version of the same API the default first.

An archived version stops its automatic URL checks and accepts no uploads or CI pushes. When you mark a URL version active again, turn Check every 6 hours back on in its Source tab.

Publish more than one API

An API is a group of versions under one name and slug, such as a Core API and a separate Payments API. Each API has its own:

• Versions: A default version plus any active, deprecated, and archived versions

• Tab: A tab in your top bar with its own name, start page, and guide sections

• Address: The first API's pages use the api-reference path. Each additional API adds its slug, such as api-reference/payments

Add another API

To add an API, import its spec as a new API instead of as a version of an existing API, and choose a slug for its address, such as payments. The slug becomes part of every page address of that API. The spec becomes the API's first version and its default. As with any import, the API's name comes from info.title.

Review and publish the import as described in Publishing an API reference from an OpenAPI spec. Add later versions of that API with the steps in Add a new version.

How readers find each API

Readers switch between APIs with the tabs in your top bar. Each tab opens its API's start page. In llms.txt, each API's endpoints are listed under the API's name.

Version limit

A Help Center can hold up to 50 API versions in total, counting the versions of all its APIs, archived versions included.

FAQs