Scopes
The 19 scopes and 3 data access flags. Read →
API reference
The REST reference is generated from the same operation catalogue the Gateway serves at GET /api/v1/openapi.json. Each operation page shows its parameters, request body, response schema, the scopes and data access it needs, and its MCP tool name.
REST API
Section titled “REST API”All operationsOne table of every operation with its MCP tool, scopes and data access.
Operation pagesParameters, schemas and examples for each operation, grouped by area.
Protocols
Section titled “Protocols”Business MCPMethods, result shapes, errors and limits.
Business A2AJSON-RPC methods, skills, task states and limits.
OAuth 2.0Token, authorize and revoke endpoints.
Concepts
Section titled “Concepts”Errors
Problem details, status codes and error codes. Read →
Identifiers
The format of every resource ID. Read →
Use the OpenAPI document
Section titled “Use the OpenAPI document”- Generate a client with OpenAPI Generator or your preferred tool.
- Import it into Postman, Insomnia or Bruno to try requests.
- Response schemas for Gateway-built responses are closed. Responses passed through from the website’s INSIDE connector list their current fields but may gain new ones, so ignore fields you don’t recognise.
Custom x- properties describe permissions: x-required-scopes, x-required-data-access, x-restriction-dimensions, x-mutation, x-idempotency-required, x-author-mapping-required, x-conditional-permissions and x-preview-only.