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

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
client.admin.workspaces.create(WorkspaceCreateParams { data_retention, name } body, RequestOptionsoptions?): WorkspaceCreateResponse { id, archived_at, created_at, 4 more }
POST/compute/v1/admin/workspaces
List workspaces
client.admin.workspaces.list(WorkspaceListParams { after_id, before_id, limit } query?, RequestOptionsoptions?): CursorPage<WorkspaceListResponse { id, archived_at, created_at, 4 more } >
GET/compute/v1/admin/workspaces
Get a workspace
client.admin.workspaces.retrieve(stringworkspaceID, RequestOptionsoptions?): WorkspaceRetrieveResponse { id, archived_at, created_at, 4 more }
GET/compute/v1/admin/workspaces/{workspace_id}
Update a workspace
client.admin.workspaces.update(stringworkspaceID, WorkspaceUpdateParams { data_retention, name } body, RequestOptionsoptions?): WorkspaceUpdateResponse { id, archived_at, created_at, 4 more }
POST/compute/v1/admin/workspaces/{workspace_id}
Archive a workspace
client.admin.workspaces.archive(stringworkspaceID, RequestOptionsoptions?): WorkspaceArchiveResponse { id, archived_at, created_at, 4 more }
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
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

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
client.admin.usage.list(UsageListParams { ending_at, starting_at, window_size, 5 more } query, RequestOptionsoptions?): OpaqueCursorPage<UsageListResponse { end_time, quantity, start_time, 2 more } >
GET/compute/v1/admin/usage