API Docs for Help Center

Your API reference and support content. One destination.

Connect your OpenAPI spec to Brainfish and surface a full interactive API reference alongside your support content — in the same Help Center your customers already use, with no separate hosting and no extra platform to manage.

Overview

Developer-facing teams have always maintained two separate destinations: an API reference in Readme or Mintlify and a help center somewhere else. Developers switch between them, search doesn't span both, and your team is stuck maintaining two platforms.

Brainfish now connects your OpenAPI spec directly to your Help Center, surfacing a full interactive API reference with operation detail views and a live HTTP client — all in one unified destination alongside your support content.

What's Included

• Unified sidebar — your support articles and API reference in one navigation

• Operation detail views — full endpoint details including parameters, request bodies, and response schemas

  

• Live HTTP client — customers can test API calls directly from the Help Center

• Conversational search across both — developers describe what they're trying to do, Brainfish surfaces the right endpoint and the right article
• No-code setup — configured entirely from the Brainfish platform dashboard

Requirements

• An OpenAPI Specification (OAS/Swagger) file for your API
• The OAS spec uploaded to Brainfish as a Catalog
• An admin to enable and configure the API Reference section in Help Center settings
• GraphQL is not supported in this release

Setup

1. Upload your OpenAPI spec to Brainfish as a Catalog

2. Navigate to Help Center → Settings in the Brainfish platform

3. Enable the API Reference section and select your OAS catalog

   

4. Configure the section label and positioning in your Help Center sidebar

5. Save — your API reference is now live inside your Help Center

Frequently Asked Questions

Does this require any code changes? No. Everything is configured from the Brainfish platform. No developer work needed.

What format does my API spec need to be in? OpenAPI Specification (OAS), also known as Swagger. Both OAS 2.0 and OAS 3.x are supported.

Is GraphQL supported? Not in this release. GraphQL support is planned for a future update.

Can I have multiple API specs? Contact your Brainfish account team to discuss multi-catalog configurations.