Your workspace, from code
A REST API for your own deployment, reached with a named API key. Everything below is generated from the same OpenAPI document the server enforces.
Areas of the API
Each area links to its operations on the developer page.
One named key, sent on every request
- Create a key under Settings › API keys in the workspace. It starts with
obk_and is shown once. - A key acts as the person who created it, never more: their current role and access are checked on every request.
- Each key carries only the scopes chosen when it was made, and can be given an expiry.
- No key can create or revoke keys.
curl -H "Authorization: Bearer $api_key" \
https://<your-deployment>/api/meBeyond plain requests
Webhooks
Signed events when something happens in the workspace, alone or in batches.
OpenAPI document
OpenAPI 3.1, so a client generator can build a typed client in your language.
Command line
A one-file command line for a terminal or a CI job, with the same keys.
MCP
Desktop assistants and code editors connect with a key that has the MCP scope.
Embedded chat
A Bot's chat on your own site, for people who are members of your workspace.
Changes and deprecations
What is changing in the API, and the dates old behaviour stops working.
Limits
| Failed key attempts from one address, per window | 20 |
|---|---|
| Failed key attempts from all addresses together, per window | 500 |
| Window length, in minutes | 10 |
| Longest expiry a key can be given, in days | 3650 |
Past a limit the server answers 429 with a Retry-After header. Conventions for scripts, paging and filters are on the developer page.