Authentication
Authenticate by including your API token in theAuthorization header using the Bearer scheme.
401 response:
Errors
The API uses standard HTTP status codes. All error responses share the same structure:details array identifying the invalid fields:
| Status | Code | Description |
|---|---|---|
| 400 | bad_request | Invalid request parameters or body |
| 401 | unauthorized | Missing or invalid API token |
| 403 | forbidden | Token is valid but lacks permission |
| 404 | not_found | Resource does not exist or is not accessible |
| 429 | rate_limited | Too many requests |
| 500 | internal_error | Unexpected server error |
Rate limiting
Requests are rate limited per API token and IP address. The default limits are:| Endpoint | Limit |
|---|---|
| Most endpoints | 60 requests/minute |
| Webhook creation | 20 requests/minute |
| File upload | 10 requests/minute |
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests allowed in the window |
X-RateLimit-Remaining | Requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the window resets |
429 with a Retry-After header indicating how many seconds to wait.
Pagination
List endpoints use cursor-based pagination. Responses include:cursor as a query parameter to fetch the next page. Control page size with limit (1-100, default 25).
has_more is false, you have reached the end of the list.
Resource IDs
All resources use prefixed IDs to make them easy to identify at a glance:| Resource | Prefix | Example |
|---|---|---|
| Meeting | mtg_ | mtg_abc123 |
| Room | room_ | room_abc123 |
| Document | doc_ | doc_abc123 |
| User | usr_ | usr_abc123 |
| Speaker | spk_ | spk_abc123 |
| Webhook | whk_ | whk_abc123 |
Expanding related resources
Some endpoints support anexpand query parameter that includes related resources inline instead of requiring separate requests. For example, to include documents with meetings: