Skip to main content
GET
Get workspace usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
enum<string> | null

Rolling window ending now. Omit for the current calendar-month billing period.

Available options:
7d,
30d,
90d

Response

Successful Response

period_start
string<date-time>
required

Start of the requested usage period (first of month if no period was given).

period_end
string<date-time>
required

Exclusive end of the requested usage period (now, if period was given).

render_minutes
number
required

Total render output duration in minutes for the period.

Example:

142.7

renders_count
integer
required

Number of billable renders (non-preview, completed) submitted during the period.

Example:

12

task_count
integer
required

Total AI tasks submitted during the period.

Example:

384

egress_bytes
integer
required

Total artifact egress bytes for the period.

Example:

5368709120

render_minutes_limit
number | null

Monthly render-minute cap for FREE-plan workspaces, on the default calendar-month billing view (period omitted). null for a paid (unmetered) plan, or when a rolling period was requested — the cap resets by calendar month, so it isn't a meaningful ceiling for an arbitrary rolling window.

Example:

30