Get usage data

$ boltz-api admin:usage list

GET/compute/v1/admin/usage

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

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

--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 4 more or array of "structure_and_binding" or "small_molecule_design" or "small_molecule_library_screen" or 4 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

ReturnsExpand Collapse

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 4 more

"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

boltz-api admin:usage list \
  --api-key 'My API Key' \
  --ending-at "'2019-12-27T18:11:19.117Z'" \
  --starting-at "'2019-12-27T18:11:19.117Z'" \
  --window-size HOUR

{
  "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"
}