workspace

Get workspace usage

Returns render minutes, render count, task count, and egress bytes for the requested period. Pass period as 7d, 30d, or 90d for a rolling window ending now; omit it for the current calendar-month billing period (the window the FREE-plan render-minute cap also resets on).

get/v1/workspace/usage

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/workspace/usage
  • Auth: HTTP bearer

Query parameters

period'7d' | '30d' | '90d' nullable

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

Response

Successful Response

period_startstring date-time required

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

period_endstring date-time required

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

render_minutesnumber required

Total render output duration in minutes for the period.

render_minutes_limitnumber nullable

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.

renders_countinteger required

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

task_countinteger required

Total AI tasks submitted during the period.

egress_bytesinteger required

Total artifact egress bytes for the period.

Example response

{
  "render_minutes": 142.7,
  "render_minutes_limit": 30,
  "renders_count": 12,
  "task_count": 384,
  "egress_bytes": 5368709120
}

Changes

No recorded changes to this operation across all 1 revision of this API.