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

Get usage data

GET/compute/v1/admin/usage

Retrieve aggregated usage data across the organization, optionally grouped by workspace and/or application.

Query ParametersExpand Collapse
ending_at: string

End of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z

formatdate-time
starting_at: string

Start of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z

formatdate-time
window_size: "HOUR" or "DAY"

Time window size. HOUR supports up to 31 days per query; DAY supports up to 365 days per query.

One of the following:
"HOUR"
"DAY"
"applications[]": optional "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 more or array of "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 more

Filter to specific applications

One of the following:
"structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 more
One of the following:
"structure_and_binding"
"small_molecule_design"
"small_molecule_library_screen"
"protein_design"
"protein_redesign"
"protein_library_screen"
"adme"
array of "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 more
One of the following:
"structure_and_binding"
"small_molecule_design"
"small_molecule_library_screen"
"protein_design"
"protein_redesign"
"protein_library_screen"
"adme"
"group_by[]": optional "workspace_id" or "application" or array of "workspace_id" or "application"

Group results by workspace_id and/or application

One of the following:
"workspace_id" or "application"
One of the following:
"workspace_id"
"application"
array of "workspace_id" or "application"
One of the following:
"workspace_id"
"application"
limit: optional number

Maximum number of buckets to return

minimum1
page: optional string

Cursor for pagination

"workspace_ids[]": optional string or array of string

Filter to specific workspace IDs

One of the following:
string
array of string
ReturnsExpand Collapse
data: array of object { end_time, quantity, start_time, 2 more }
end_time: string
formatdate-time
quantity: number

Aggregated billed quantity for this bucket

start_time: string
formatdate-time
application: optional "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 more
One of the following:
"structure_and_binding"
"small_molecule_design"
"small_molecule_library_screen"
"protein_design"
"protein_redesign"
"protein_library_screen"
"adme"
workspace_id: optional string

Present when grouped by workspace_id

has_more: boolean
next_page: string

Get usage data

curl https://api.boltz.bio/compute/v1/admin/usage \
    -H "x-api-key: $BOLTZ_API_KEY"
{
  "data": [
    {
      "end_time": "2019-12-27T18:11:19.117Z",
      "quantity": 0,
      "start_time": "2019-12-27T18:11:19.117Z",
      "application": "structure_and_binding",
      "workspace_id": "workspace_id"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}
Returns Examples
{
  "data": [
    {
      "end_time": "2019-12-27T18:11:19.117Z",
      "quantity": 0,
      "start_time": "2019-12-27T18:11:19.117Z",
      "application": "structure_and_binding",
      "workspace_id": "workspace_id"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}