---
title: "Get workspace usage"
method: GET
path: "/v1/workspace/usage"
tags: ["workspace"]
---

# Get workspace usage

`GET /v1/workspace/usage`

## Request

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

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).

## Query parameters

- `period` '7d' | '30d' | '90d', nullable: Rolling window ending now. Omit for the current calendar-month billing period.

## Response `200`

Successful Response

- WorkspaceUsage
  - `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.
  - `render_minutes_limit` number, 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_count` integer, required: Number of billable renders (non-preview, completed) submitted during the period.
  - `task_count` integer, required: Total AI tasks submitted during the period.
  - `egress_bytes` integer, required: Total artifact egress bytes for the period.

## Other responses

- `401`: Missing or invalid API key.
- `422`: Validation Error

---

[API](https://skmtc.dev/framelane/apis/framelane-api.md) · [All operations](https://skmtc.dev/framelane/apis/framelane-api/llms.txt) · [OpenAPI document](https://skmtc.dev/framelane/apis/framelane-api/revisions/a223001ca8e5?raw)