Apiome user guide
Apiome is where teams design, govern and ship APIs. One path — the spine — runs through the whole product:
import a spec → edit a class and a path → lint → cut a version → publish → browse → export with the CLI → query with MCP
This user guide is for everyone who works in Apiome. It is organised by the job you are doing, in the same order as the product's navigation rail:
| Section | What it covers |
|---|---|
| Getting started | Signing in, your first organization and project, versions, publishing and exports — the pages below |
| Build | Projects, versions and the Studio editor |
| Bring in | The catalog, the import wizard and repositories |
| Ship | Publishing, the sunset timeline, exports and mocks |
| Govern | Lint posture, reviews and shadow APIs |
| Workspace & account | Members, roles, API keys, tenants, your profile and preferences |
The other guides
| Guide | For |
|---|---|
| Administration guide | People who run an Apiome installation: the admin console, sign-in providers, the data browser, migrations, operating and hosting |
| CLI | Working from a terminal or CI with the apiome command: the quick-start and every command |
| Reference | The REST API, the MCP server, the mock runtime and the CI actions |
| Release notes | What changed in each release |
Each guide has its own entry in the top bar and its own sidebar, and the documentation home links to all of them.
Start here
Follow these pages in order — from signing in to a published, browsable spec:
- Run Apiome locally — only if you are trying Apiome on your own machine
- Sign in and create an account
- Set up your first organization
- The launcher and Home
- Import your first project
- Version and publish
- Browse and export
- Connect an MCP host
- Keyboard and preferences
Moved from the repository
These pages used to live in the repository's docs/guide/ folder. Its
README maps each old file to its
page here.