Skip to Content
APIOverview

API

Every capability the API key may call is available in three ways, all served by the gateway:

EndpointUse it for
POST /api/v1/capabilities/{name}Calling a capability from an application. See REST
POST /mcpCalling capabilities as tools from an AI agent. See MCP
GET /openapi.jsonGenerating clients or reviewing the contract. See OpenAPI

Capabilities that take or return files use the same endpoints plus GET /api/v1/files/{id}; see Files. GET /healthz reports whether the agent is connected and is the only endpoint that needs no API key; see Healthz.

REST and MCP return the same result envelope and the same error codes.