---
title: "Get a workspace-scoped usage and credit report"
method: GET
path: "/v1/usage"
tags: ["Usage"]
---

# Get a workspace-scoped usage and credit report

`GET /v1/usage`

## Query parameters

- `from` string, date-time
- `to` string, date-time

## Response `200`

Workspace usage report

- UsageReportResponse
  - `request_id` string, required
  - `execution` Execution, required
    - `location` 'local' | 'cloud', required
    - `capability_id` string, nullable
    - `capability_version` string, nullable
  - `usage` Usage, required
    - `billable` boolean, required
    - `quantity` number, required
    - `unit` string, required
    - `credits` number
  - `warnings` string[], required
  - `data` UsageReport, required
    - `workspace_id` string, required
    - `credits_available` number, required
    - `period_start` string, date-time, required
    - `period_end` string, date-time, required — Exclusive report end
    - `meters` UsageMeterTotal[], required
      - `meter_id` string, required
      - `quantity` number, required
      - `unit` string, required
      - `credits` number, required

## Other responses

- `default` — Standard Cerul error envelope

## Changes

- **2026-07-27** `c15615d54993` — 16 breaking, 1 warning, 8 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the required property `api_keys_active` from the response with the `200` status
  - removed the required property `billing_hold` from the response with the `200` status
  - removed the required property `credit_breakdown` from the response with the `200` status
  - …21 more
- **2026-04-08** `6cccdc178a95` — 4 warning, 12 info
  - added the new `internal_error` enum value to the `error/code` response property for the response status `401`
  - added the new `internal_error` enum value to the `error/code` response property for the response status `403`
  - added the new `internal_error` enum value to the `error/code` response property for the response status `429`
  - added the new `internal_error` enum value to the `error/code` response property for the response status `500`
  - …12 more
- **2026-04-04** `503281cd9fb3` — 17 warning, 4 info
  - the optional response header `x-request-id` removed for the status `200`
  - the optional response header `x-request-id` removed for the status `401`
  - the optional response header `x-request-id` removed for the status `403`
  - the optional response header `x-request-id` removed for the status `429`
  - …17 more

[Change history](https://skmtc.dev/cerul-ai/apis/cerul-api/changes/v1/usage/get.md)

---

[API](https://skmtc.dev/cerul-ai/apis/cerul-api.md) · [All operations](https://skmtc.dev/cerul-ai/apis/cerul-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cerul-ai/cerul-api/revisions/c15615d54993/schema)