# Admin # Workspaces ## Create `$ boltz-api admin:workspaces create` **post** `/compute/v1/admin/workspaces` Create a workspace ### Parameters - `--data-retention: optional object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `--name: optional string` Workspace name ### Returns - `AdminWorkspaceNewResponse: object { id, archived_at, created_at, 4 more }` - `id: string` Workspace ID - `archived_at: string` - `created_at: string` - `data_retention: object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `unit: "hours" or "days"` Time unit for retention duration - `"hours"` - `"days"` - `value: number` Duration value. Maximum retention is 14 days (or 336 hours). - `is_default: boolean` Whether this is the default workspace - `name: string` Workspace name - `updated_at: string` ### Example ```cli boltz-api admin:workspaces create ``` ## List `$ boltz-api admin:workspaces list` **get** `/compute/v1/admin/workspaces` List workspaces ### Parameters - `--after-id: optional string` Return results after this ID - `--before-id: optional string` Return results before this ID - `--limit: optional number` Max items to return ### Returns - `ListWorkspacesResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, archived_at, created_at, 4 more }` - `id: string` Workspace ID - `archived_at: string` - `created_at: string` - `data_retention: object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `unit: "hours" or "days"` Time unit for retention duration - `"hours"` - `"days"` - `value: number` Duration value. Maximum retention is 14 days (or 336 hours). - `is_default: boolean` Whether this is the default workspace - `name: string` Workspace name - `updated_at: string` - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. ### Example ```cli boltz-api admin:workspaces list ``` ## Retrieve `$ boltz-api admin:workspaces retrieve` **get** `/compute/v1/admin/workspaces/{workspace_id}` Get a workspace ### Parameters - `--workspace-id: string` ### Returns - `AdminWorkspaceGetResponse: object { id, archived_at, created_at, 4 more }` - `id: string` Workspace ID - `archived_at: string` - `created_at: string` - `data_retention: object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `unit: "hours" or "days"` Time unit for retention duration - `"hours"` - `"days"` - `value: number` Duration value. Maximum retention is 14 days (or 336 hours). - `is_default: boolean` Whether this is the default workspace - `name: string` Workspace name - `updated_at: string` ### Example ```cli boltz-api admin:workspaces retrieve \ --workspace-id workspace_id ``` ## Update `$ boltz-api admin:workspaces update` **post** `/compute/v1/admin/workspaces/{workspace_id}` Update a workspace ### Parameters - `--workspace-id: string` - `--data-retention: optional object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `--name: optional string` ### Returns - `AdminWorkspaceUpdateResponse: object { id, archived_at, created_at, 4 more }` - `id: string` Workspace ID - `archived_at: string` - `created_at: string` - `data_retention: object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `unit: "hours" or "days"` Time unit for retention duration - `"hours"` - `"days"` - `value: number` Duration value. Maximum retention is 14 days (or 336 hours). - `is_default: boolean` Whether this is the default workspace - `name: string` Workspace name - `updated_at: string` ### Example ```cli boltz-api admin:workspaces update \ --workspace-id workspace_id ``` ## Archive `$ boltz-api admin:workspaces archive` **post** `/compute/v1/admin/workspaces/{workspace_id}/archive` Archives a workspace and deactivates all its API keys. This action is irreversible. ### Parameters - `--workspace-id: string` ### Returns - `AdminWorkspaceArchiveResponse: object { id, archived_at, created_at, 4 more }` - `id: string` Workspace ID - `archived_at: string` - `created_at: string` - `data_retention: object { unit, value }` How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours). - `unit: "hours" or "days"` Time unit for retention duration - `"hours"` - `"days"` - `value: number` Duration value. Maximum retention is 14 days (or 336 hours). - `is_default: boolean` Whether this is the default workspace - `name: string` Workspace name - `updated_at: string` ### Example ```cli boltz-api admin:workspaces archive \ --workspace-id workspace_id ``` # API Keys ## Create `$ boltz-api admin:api-keys create` **post** `/compute/v1/admin/api-keys` Create a workspace API key ### Parameters - `--name: string` API key name - `--allowed-ip: optional array of string` IP addresses allowed to use this key (IPv4 or IPv6). An empty array (the default) means all IPs are allowed. - `--expires-in-days: optional number` Days until the key expires. Omit for a key that does not expire. - `--mode: optional "live" or "test"` Key mode. Test keys create test-mode resources with synthetic data. - `--workspace-id: optional string` Workspace ID to scope this key to. Omit for default workspace. ### Returns - `AdminAPIKeyNewResponse: object { key, key_details }` - `key: string` The full API key. This is only shown once — store it securely. - `key_details: object { id, allowed_ips, created_at, 8 more }` - `id: string` API key ID - `allowed_ips: array of string` IP addresses allowed to use this key. An empty array means all IPs are allowed. - `created_at: string` - `expires_at: string` When the key expires. Null if the key does not expire. - `is_active: boolean` - `key_prefix: string` First 12 characters of the key - `key_type: "workspace"` - `"workspace"` - `last_used_at: string` - `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 ### Example ```cli boltz-api admin:api-keys create \ --name x ``` ## List `$ boltz-api admin:api-keys list` **get** `/compute/v1/admin/api-keys` List API keys ### Parameters - `--after-id: optional string` Return results after this ID - `--before-id: optional string` Return results before this ID - `--limit: optional number` Max items to return - `--workspace-id: optional string` Filter by workspace ID. If not provided, returns keys across all workspaces. ### Returns - `ListApiKeysResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, allowed_ips, created_at, 8 more }` - `id: string` API key ID - `allowed_ips: array of string` IP addresses allowed to use this key. An empty array means all IPs are allowed. - `created_at: string` - `expires_at: string` When the key expires. Null if the key does not expire. - `is_active: boolean` - `key_prefix: string` First 12 characters of the key - `key_type: "admin" or "workspace"` - `"admin"` - `"workspace"` - `last_used_at: string` - `livemode: boolean` Whether this is a live API key (false for test keys). - `name: string` API key name - `workspace_id: string` Workspace ID if workspace-scoped - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. ### Example ```cli boltz-api admin:api-keys list ``` ## Revoke `$ boltz-api admin:api-keys revoke` **post** `/compute/v1/admin/api-keys/{api_key_id}/revoke` Revoke an API key ### Parameters - `--api-key-id: string` ### Returns - `AdminAPIKeyRevokeResponse: object { id, allowed_ips, created_at, 8 more }` - `id: string` API key ID - `allowed_ips: array of string` IP addresses allowed to use this key. An empty array means all IPs are allowed. - `created_at: string` - `expires_at: string` When the key expires. Null if the key does not expire. - `is_active: boolean` - `key_prefix: string` First 12 characters of the key - `key_type: "admin" or "workspace"` - `"admin"` - `"workspace"` - `last_used_at: string` - `livemode: boolean` Whether this is a live API key (false for test keys). - `name: string` API key name - `workspace_id: string` Workspace ID if workspace-scoped ### Example ```cli boltz-api admin:api-keys revoke \ --api-key-id api_key_id ``` # Usage ## List `$ boltz-api admin:usage list` **get** `/compute/v1/admin/usage` Retrieve aggregated usage data across the organization, optionally grouped by workspace and/or application. ### Parameters - `--ending-at: string` End of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z - `--starting-at: string` Start of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z - `--window-size: "HOUR" or "DAY"` Time window size. HOUR supports up to 31 days per query; DAY supports up to 365 days per query. - `--applications: optional "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 3 more or array of "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 3 more` Filter to specific applications - `--group-by: optional "workspace_id" or "application" or array of "workspace_id" or "application"` Group results by workspace_id and/or application - `--limit: optional number` Maximum number of buckets to return - `--page: optional string` Cursor for pagination - `--workspace-ids: optional string or array of string` Filter to specific workspace IDs ### Returns - `UsageResponse: object { data, has_more, next_page }` - `data: array of object { end_time, quantity, start_time, 2 more }` - `end_time: string` - `quantity: number` Aggregated billed quantity for this bucket - `start_time: string` - `application: optional "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 3 more` - `"structure_and_binding"` - `"small_molecule_design"` - `"small_molecule_library_screen"` - `"protein_design"` - `"protein_library_screen"` - `"adme"` - `workspace_id: optional string` Present when grouped by workspace_id - `has_more: boolean` - `next_page: string` ### Example ```cli boltz-api admin:usage list \ --ending-at 2019-12-27T18:11:19.117Z \ --starting-at 2019-12-27T18:11:19.117Z \ --window-size HOUR ```