​
Base URL

Not writing code? An AI assistant can call this API for you through the MCP server, using the same key.

​
Authentication

Most endpoints require an API key. Create one under Settings → API. Keys are shown once, at creation, and carry a bhokan_ prefix. Send the key as a bearer token:
The X-API-Key header is accepted as an alternative:
A key belongs to a user, not a workspace. One key reaches every workspace its owner is a member of, and each request is authorised against that workspace’s membership and role.

​
Plan requirements

REST access is a plan capability. If the workspace a request reaches into is on a plan without the REST API, the request fails with 403 and a message saying so, regardless of the key’s validity.

​
Rate limits

Two limits apply, and either can return 429: The plan quota is counted per workspace rather than per key, so issuing more keys does not raise it. When it is exceeded, the response says how many requests per minute the plan allows.

​
Response codes

Bhokan uses standard HTTP codes to indicate the success or failure of your requests. In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.

​
Identifiers

Every entity is addressed by its 12-character public ID — publicId in responses, and the ...PublicId path parameters throughout this reference. Internal database IDs are never exposed and cannot be used in requests.