Skip to content

API reference ​

Every route of the REST API, grouped by family and generated from the same OpenAPI document the instance serves at GET /api/v1/openapi.json. Each page lists the routes of one family with their access rule, parameters, request body, responses and error codes, exactly as the product defines them.

Before calling a route, read Authentication and Scopes; the shape of every error is on Errors.

FamilyRoutes
Authentication5 routes
My account7 routes
API keys5 routes
Members and invitations7 routes
Governance9 routes
Audit log1 route
OAuth3 routes
Connections6 routes
AI models17 routes
Mailboxes9 routes
Messages12 routes
Threads3 routes
Folders1 route
Signatures8 routes
Address book19 routes
Workflows24 routes
Executions10 routes
Prompt evaluation5 routes
Templates6 routes
Tables18 routes
Approvals3 routes
Morning review and sending journal8 routes
Notifications and incidents8 routes
Mailbox analyzer8 routes
Assistant10 routes
Dashboard10 routes
Node catalog2 routes
Inbound webhooks1 route
Health4 routes
MCP server1 route