Apiome Suite user guide
The Apiome Suite is the commercial studio beside Apiome. Where the open-source product is where you import, version, govern and publish an API, the Suite is where you design it on a canvas, write its documentation with grounded AI, and publish that documentation as a portal. One path runs through it:
open a project version in the workspace → model its schemas and paths → fill the documentation gaps with Scribe → design a portal with Slate → build, preview and release it
This user guide is for everyone who works in the Suite. It is organised by surface, in the order of the Suite's own navigation:
| Section | What it covers |
|---|---|
| Getting started | Signing in, the Suite home and navigation, your first design and your first portal, plans — the pages below |
| Design | The Designer workspace: schemas, paths, code and exports, comments, try-it and the AI assistant |
| Authoring | The Authoring Overview, Guides, the Changelog and the reference gallery |
| Scribe | AI-assisted writing: the content workspace, coverage, the README generator, style guide, stale alerts and settings |
| Slate | Portal publishing: theme, navigation, content blocks, preview, builds, export, versions, domains and settings |
| Hosted | The hosted plan: Releases, Cache, Security, Edge and Insights |
Data DesignerSchema designModel classes, relationships and constraints on an interactive canvas.PathsAPI surfaceAuthor OpenAPI paths, operations and request/response contracts.WorkspaceSchemas and paths togetherOne domain-scoped workspace with a Schemas lens, a Paths lens and a Combined lens.AuthoringDocs & portalsReadiness, coverage, releases and delivery for your documentation.ScribePreviewAI-assisted writingAuthor cited reference content and guides with grounded AI proposals.SlatePreviewPortal publishingDesign, preview and publish documentation portals from your catalog.ReleasesPreviewHosted deliveryPreviews, production, promotion and rollback for hosted portals.InsightsPreviewSignalsContent, search, API, delivery and cost signals for hosted portals.
The other guides
| Guide | For |
|---|---|
| Administration guide | People who run a Suite installation: the studio image, Spire, sign-in, licensing and releases |
| Reference | Routes, entitlements, the Spire API and the glossary |
| Release notes | What changed in each release |
| Apiome documentation | The open-source product: projects, versions, the catalog, governance, the CLI and the REST API |
Start here
- What is the Suite? — how it fits beside Apiome
- Sign in
- Suite home and navigation
- Design your first API
- Publish your first portal
- Plans and entitlements — what you see without a plan