Skip to content
Go to Boltz API

Admin

Manage workspaces and API keys. Requires an admin API key. Admin keys have full access to all management and compute operations across all workspaces in the organization.

AdminWorkspaces

Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.

Create a workspace
$ boltz-api admin:workspaces create
POST/compute/v1/admin/workspaces
List workspaces
$ boltz-api admin:workspaces list
GET/compute/v1/admin/workspaces
Get a workspace
$ boltz-api admin:workspaces retrieve
GET/compute/v1/admin/workspaces/{workspace_id}
Update a workspace
$ boltz-api admin:workspaces update
POST/compute/v1/admin/workspaces/{workspace_id}
Archive a workspace
$ boltz-api admin:workspaces archive
POST/compute/v1/admin/workspaces/{workspace_id}/archive

AdminAPI 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
$ boltz-api admin:api-keys create
POST/compute/v1/admin/api-keys
List API keys
$ boltz-api admin:api-keys list
GET/compute/v1/admin/api-keys
Revoke an API key
$ boltz-api admin:api-keys revoke
POST/compute/v1/admin/api-keys/{api_key_id}/revoke

AdminUsage

Retrieve aggregated usage data for the organization. Usage can be grouped by workspace and/or application, and filtered by time range, workspace, and application.

Get usage data
$ boltz-api admin:usage list
GET/compute/v1/admin/usage