Skip to content
Go to Boltz API

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