Start here/Authentication

Authentication

One header, one key. There are no OAuth flows, no tokens to refresh and no signed requests.

API keys

Create keys in the dashboard under API keys. A key is shown in full once, at creation. After that only its first characters are visible, so store it wherever you keep secrets before closing the dialog.

NOTE
That is not a policy we could relax: only a hash of the key is stored, so there is nothing left to show you. A lost key is replaced, never recovered.

Test keys are prefixed tbx_test_ and live keys tbx_live_. Both bill the same way; the prefix is there so you can tell at a glance which environment a leaked key belongs to.

What a key can see

Keys are scoped to the workspace that created them. Reading a job that belongs to another workspace returns 404, not 403, so a wrong key cannot be used to discover which job IDs exist.

Rotating a key

Create the replacement first, deploy it, then revoke the old one. Revoking takes effect immediately and cannot be undone. Jobs already queued under a revoked key still finish; you can still read their results with any live key in the same workspace.

Was this page useful?Tell us what was missing