Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Admin

API Keys

API keys authenticate requests to the Boltz API. There are two key types: admin keys have full access to all management and compute operations across the organization, while workspace keys are scoped to a single workspace and can only perform compute operations (predictions, protein design, small molecule design) within that workspace. Keys can be created in live or test mode. Test keys (prefixed sk_bc_*_test_) create test-mode resources with synthetic data and no GPU cost. Every resource includes a livemode field indicating its mode.

Create a workspace API key
client.admin.apiKeys.create(APIKeyCreateParams { name, allowed_ips, expires_in_days, 2 more } body, RequestOptionsoptions?): APIKeyCreateResponse { key, key_details }
POST/compute/v1/admin/api-keys
List API keys
client.admin.apiKeys.list(APIKeyListParams { after_id, before_id, limit, workspace_id } query?, RequestOptionsoptions?): CursorPage<APIKeyListResponse { id, allowed_ips, created_at, 8 more } >
GET/compute/v1/admin/api-keys
Revoke an API key
client.admin.apiKeys.revoke(stringapiKeyID, RequestOptionsoptions?): APIKeyRevokeResponse { id, allowed_ips, created_at, 8 more }
POST/compute/v1/admin/api-keys/{api_key_id}/revoke
ModelsExpand Collapse
APIKeyCreateResponse { key, key_details }
key: string

The full API key. This is only shown once — store it securely.

key_details: KeyDetails { id, allowed_ips, created_at, 8 more }
id: string

API key ID

allowed_ips: Array<string>

IP addresses allowed to use this key. An empty array means all IPs are allowed.

created_at: string
formatdate-time
expires_at: string | null

When the key expires. Null if the key does not expire.

formatdate-time
is_active: boolean
key_prefix: string

First 12 characters of the key

key_type: "workspace"
last_used_at: string | null
formatdate-time
livemode: boolean

Whether this is a live API key (false for test keys).

name: string

API key name

workspace_id: string

Workspace this key is scoped to

APIKeyListResponse { id, allowed_ips, created_at, 8 more }
id: string

API key ID

allowed_ips: Array<string>

IP addresses allowed to use this key. An empty array means all IPs are allowed.

created_at: string
formatdate-time
expires_at: string | null

When the key expires. Null if the key does not expire.

formatdate-time
is_active: boolean
key_prefix: string

First 12 characters of the key

key_type: "admin" | "workspace"
One of the following:
"admin"
"workspace"
last_used_at: string | null
formatdate-time
livemode: boolean

Whether this is a live API key (false for test keys).

name: string

API key name

workspace_id: string | null

Workspace ID if workspace-scoped

APIKeyRevokeResponse { id, allowed_ips, created_at, 8 more }
id: string

API key ID

allowed_ips: Array<string>

IP addresses allowed to use this key. An empty array means all IPs are allowed.

created_at: string
formatdate-time
expires_at: string | null

When the key expires. Null if the key does not expire.

formatdate-time
is_active: boolean
key_prefix: string

First 12 characters of the key

key_type: "admin" | "workspace"
One of the following:
"admin"
"workspace"
last_used_at: string | null
formatdate-time
livemode: boolean

Whether this is a live API key (false for test keys).

name: string

API key name

workspace_id: string | null

Workspace ID if workspace-scoped