English
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.
| Family | Routes |
|---|---|
| Authentication | 5 routes |
| My account | 7 routes |
| API keys | 5 routes |
| Members and invitations | 7 routes |
| Governance | 9 routes |
| Audit log | 1 route |
| OAuth | 3 routes |
| Connections | 6 routes |
| AI models | 17 routes |
| Mailboxes | 9 routes |
| Messages | 12 routes |
| Threads | 3 routes |
| Folders | 1 route |
| Signatures | 8 routes |
| Address book | 19 routes |
| Workflows | 24 routes |
| Executions | 10 routes |
| Prompt evaluation | 5 routes |
| Templates | 6 routes |
| Tables | 18 routes |
| Approvals | 3 routes |
| Morning review and sending journal | 8 routes |
| Notifications and incidents | 8 routes |
| Mailbox analyzer | 8 routes |
| Assistant | 10 routes |
| Dashboard | 10 routes |
| Node catalog | 2 routes |
| Inbound webhooks | 1 route |
| Health | 4 routes |
| MCP server | 1 route |