Answers to questions about API documentation that span several settings: which specs you can import, how Try it behaves, how the API reference tab is organized, who can edit it, and how Fibi AI Agent uses it. Each guide in this collection covers its own task in more detail, starting with the API documentation overview.

Importing specs

Which OpenAPI versions and file formats are supported?

Featurebase imports OpenAPI 3.0 and 3.1 specs as JSON or YAML, with one document per file. Publishing an API reference from an OpenAPI spec covers the import itself.

Can I import Swagger 2.0, GraphQL, or AsyncAPI files?

No. Convert a Swagger 2.0 spec to OpenAPI 3.0 or 3.1 with a converter tool first, then import the converted file. GraphQL schemas and AsyncAPI files are not supported.

Why did my import warn about or fail on external $ref files?

Featurebase never fetches files that your spec points to with a $ref to another file or URL. How it handles them depends on how many there are:

• 20% of the $refs or fewer: The import continues and warns you that those references were not loaded

• More than 20%: The import stops and asks you to bundle the spec into one file

Bundle the spec into a single file with your API tooling, then import it again.

Try it and downloads

Why is Try it missing or without a Send button?

Check these settings on the version's Settings tab and in your spec:

• Try it mode is Off: Endpoint pages have no Try it button

• Try it mode is Samples only: Try it opens the request builder and example responses without Send

• The spec has no servers: Try it shows samples only

• The endpoint is a webhook or has x-hideTryItPanel: true: That page has no Try it button

If Send appears but requests fail, run 'Test connection' for the server. Code samples and the API playground explains each mode and the connection test.

Can readers test against a private or local server?

No. Try it only sends requests to public HTTPS servers on the standard port (443) that are in your spec and that you allow under Allowed servers. Local hosts, IP addresses, and internal network names are blocked. For a private API, choose Samples only, so readers can still copy the request code.

How do readers download the spec?

On any API reference page, readers open the page actions menu and choose 'Download spec'. They get a JSON file of the published version they are viewing, built from the endpoints you publish rather than from the file you uploaded.

Organizing and editing

Can I publish several APIs in one Help Center?

Yes. Each API has its own versions, default version, and tab in your top bar, with its own name, start page, and guide sections. Readers switch between APIs with the tabs. Managing API versions and multiple APIs explains how to add an API.

Can I put guides inside the API reference tab?

Yes. Add a collection or picked articles as guide sections under Pages in Settings → Help Center → API reference. They appear above the endpoint groups for every version of that API, and you can also make an article the tab's start page. Organizing the API reference tab covers both.

What happens to my endpoint intros when an endpoint changes?

Spec updates never change an intro, and an intro moves with its endpoint when the path changes but the operationId stays the same. Organizing the API reference tab explains what happens when an endpoint disappears and how intros work across versions.

Can I document an endpoint that is not in my spec?

Yes. Write it in a regular article with the API blocks from the / menu, as described in the Help Center block library.

Can I make an API version private?

The dashboard has no setting for it. You can limit a version to roles and segments with the Featurebase API, or archive it to take it away from everyone, as described in Managing API versions and multiple APIs.

Who can edit API documentation?

Teammates with the Manage Help Center permission can import specs, review and publish changes, and organize the API reference tab. Choosing relay mode for Try it, changing the allowed servers, turning on publishing without review for CI pushes, and creating an API key for CI also need the Manage API permission. Admin roles explains how to give these permissions.

Fibi and AI tools

Does Fibi answer from my API documentation?

Yes. When your Help Center is a knowledge source for Fibi AI Agent, Fibi also searches the published endpoints of your API reference. It uses the Help Center of the conversation's brand, or your Workspace's active Help Center.

• Version: Fibi reads the default version of each API

• Endpoints per answer: Up to three matching endpoints, linked as sources

• What it reads: Each endpoint's method, path, title, description, required parameters, and authentication. Fibi does not read full example payloads or response schemas

• Access: Only endpoints the customer is allowed to see

Are my endpoints listed in llms.txt?

Yes, by default. List in llms.txt on the version's Settings tab adds the endpoint pages of the API's default version to your Help Center's llms.txt. Making your Help Center readable for AI tools explains the index.

Limits

Is there a limit to APIs and versions?

A Help Center can hold up to 50 API versions, archived versions included, as described in Managing API versions and multiple APIs.