Skip to main content

REST API reference

The Apiome REST API, version 1.204.1 — 773 operations under 80 tags (and 8 untagged), generated from apiome-rest/openapi.yaml. Each tag has a page listing its endpoints with their parameters, request bodies, responses and the schemas they use. A running service also serves the same document interactively — see API reference for Swagger UI and ReDoc.

Authentication​

Endpoints that need a caller accept either of these schemes:

SchemeTypeSent asDescription
ApiKeyapiKeyX-API-Key headerAPI key for tenant-scoped access (alternative to JWT)
BearerhttpAuthorization: Bearer …JWT token from NextAuth (Authorization: Bearer <token>)

Tags​

TagOperations
Access14
Admin auth providers3
Agent access22
Agent outputs1
API check suite10
API keys2
Browse9
Catalog10
Change report templates4
Classes11
Classified diff1
Comments10
Compatibility3
Consumer contracts10
Contract assurance23
Data6
Deploy gate4
Domains6
Draft bindings7
Export11
Export jobs6
Export mock6
Formats1
Governance25
Identity4
Import sources4
Internal auth providers1
License1
Lint11
Lint decisions4
Lint workspace9
MCP catalog80
MCP keys7
MCP manifest3
MCP policy3
MCP probe6
MCP trust drift4
Migration plans3
Mock server20
Notifications3
Onboarding5
OpenAPI change report1
Ops9
Paths33
Platform admin1
Primitives12
Project tags7
Projects11
Properties5
Provider checks4
Registry audit1
Repository webhooks1
Reviews7
Schema test suites11
Schema validation3
SDK generation3
SDK git delivery6
SDK publishing6
SDK regen7
Slate17
Slate cache10
Slate functions27
Slate git preview8
Slate insights29
Slate security19
Snippets1
Spec import14
Spec sync4
Style guides19
Tenant repositories28
Tenants3
Type registry8
Types public1
Untagged8
Version change report4
Version changelog2
Version tags4
Versions52
Webhooks6
Workflow audit1
Workspace10