Skip to main content

Base URL

Every API path hangs from /v1. If your organization has its own installation, use the URL you were given.

Sending the key

Every /v1 path requires an API key. Send it in either of these headers:
string
Bearer bkg_live_…. The standard form, used by most HTTP clients and by the MCP.
string
bkg_live_…, without a prefix. Equivalent to the previous one.
Keep the key in an environment variable or a secrets manager, never in your code. How to create and revoke it: API keys.

What each key can see

A key of a person with the viewer role, or an organization key marked read_only, only reads: it can run every GET and the POST requests that save nothing. See Accounts and organizations.

Optional headers

string
The case you are working on (case_…). Queries that carry it are recorded in the case’s chain of custody, and labels you add count only inside that case. If it names a case you cannot see, the response is 400 with error: "case_unavailable" and the query is not run.

Authentication responses