API Fleet documentation
Build a developer portal from an OpenAPI document, shape it for your users, and publish a versioned snapshot. These guides follow the same path a new workspace takes in the product—from the first spec to an advanced, branded portal.
Start here
Build your first portal
Connect or paste an OpenAPI document, generate a portal, customize access and navigation, preview it, and publish the first live build.
Connect and update API specifications
Paste a spec or connect GitHub, understand sync status, and review differences between the latest source and the version currently published.
Understand the portal JSON format
Create or move a complete portal as one portable JSON document. Use this when you want repeatable setups, reviewable changes, or agent-authored portals.
Browse every component
The exhaustive contract for themes, pages, blocks, navigation, limits, and allowed values.
Build
Create pages and navigation
Turn an API reference into documentation clients can learn from: quickstarts, guides, page gates, tabs, groups, external links, and search.
Customize the visual system
Use theme tokens first, then trusted custom CSS for the details. Includes the stable CSS hooks and current product limits.
Art-direction & backgrounds
The declarative theme.background layer stack — rich hero/page backgrounds with
no custom CSS or JS. Design rationale and the coding-agent authoring guide; the
shipped schema is §2.7 of the component reference.
Publish
Preview, publish, restore, and add a domain
Understand drafts and immutable builds, safely update a live portal, roll back, configure access, and serve the portal on your own hostname.
Troubleshoot a portal
Fix the most common spec, import, publishing, access, and domain problems.
The shortest useful path
- Prepare a valid OpenAPI 3.x YAML or JSON file.
- Create a workspace and add the spec from GitHub or paste it directly.
- Generate a portal from the connected spec.
- Add guides and structure the navigation.
- Configure who can see the portal and its individual pages.
- Preview the exact build, then publish it.
- Export the portal JSON before advanced automation or large changes.
API Fleet keeps editing state and published state separate. Your current draft can change without changing what clients see. A publish creates a new, immutable build that can be restored later.
Need a missing detail?
Email hello@apifleet.io. Include the page you were following, what you expected, and the last step that worked.