Apiome Suite documentation
Design, author and publish
The Apiome Suite is the commercial studio beside Apiome. Model classes and paths in the Designer workspace, write cited reference content and guides with Scribe, design and publish documentation portals with Slate, and ship them through hosted releases with edge caching, security and insights.
Find your way
User guideWork in the Suite: design schemas and paths, author content with Scribe, publish portals with Slate.AdministrationRun a Suite installation: the studio image, Spire, sign-in, licensing and releases.ReferenceEvery route, entitlement and environment variable, the Spire API and the glossary.Release notesWhat changed in each Apiome Suite release.
Quick links
The Suite at a glance
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.