---
title: "Get Ledger"
method: GET
path: "/workspaces/{workspace_id}/agent/ledger"
tags: ["copilot"]
---

# Get Ledger

`GET /workspaces/{workspace_id}/agent/ledger`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/workspaces/{workspace_id}/agent/ledger`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

This month's agent spend: committed, used, remaining and who pays.

## Path parameters

- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- Ledger
  - `month` string, required
  - `agent` Envelope, required
    - `payer` 'os3' | 'customer', required
    - `budget_usd` string, nullable, required
    - `committed_usd` string, required
    - `used_usd` string, required
    - `remaining_usd` string, nullable, required
  - `automatic` Envelope, required
    - `payer` 'os3' | 'customer', required
    - `budget_usd` string, nullable, required
    - `committed_usd` string, required
    - `used_usd` string, required
    - `remaining_usd` string, nullable, required
  - `runs` Envelope, required
    - `payer` 'os3' | 'customer', required
    - `budget_usd` string, nullable, required
    - `committed_usd` string, required
    - `used_usd` string, required
    - `remaining_usd` string, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/0278b5810d1d?raw)