Headless doc portal (API)
- When to use the Portal API
- Explore the documentation structure
- Search across documentation
- Retrieve page content
The Portal API provides access to API documentation hosted on Bump.sh programmatically. The API returns structured content through a REST API call, with the same level of content as the visual API doc.
The Portal API currently works on public docs.
When to use the Portal API #
The Portal API is useful when you want to build your own integration on top of Bump.sh documentation, without relying on the MCP protocol. Typical use cases include:
- Integrating documentation content into your own developer portal or tooling
- Building a custom search interface for your API documentation
- Feeding structured doc content into AI pipelines or RAG systems
- Automating documentation audits or content extraction
If you’re looking to connect your AI assistant to an API doc portal hosted on Bump.sh, the portal MCP server is the way to go. It’s built on top of the Portal API.
Explore the documentation structure #
You can use the GET /list endpoint to list all child pages under a given URL in the portal hierarchy. It returns each page’s URL, title, type, and a short description. It’s useful as a starting point to understand what a portal contains before fetching specific pages.
Search across documentation #
You can use the GET /search endpoint to search across all documentation pages in a portal by keyword. Results include URL, title, type, and a text excerpt for each page. You can optionally filter by page URL or by page type (operation, model, guide, etc.).
Retrieve page content #
You can use the GET /fetch endpoint to retrieve the full content of one or more pages by their URLs (up to 10 per request). Content is returned in Markdown format.
A common flow is to call GET /search first to identify relevant pages, then GET /fetch to read their full content.