---
title: "Optimisation Budgets"
method: GET
path: "/budget/optimisation"
tags: ["usage"]
---

# Optimisation Budgets

`GET /budget/optimisation`

## 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/budget/optimisation`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

The organisation's monthly optimisation budgets. Each meter's cap is its plan's default
(``default`` true, ``default_cap``) until OS3 sets the organisation's own cap (``set_by``,
``set_at``): ask OS3 to raise it.

## Response `200`

Successful Response

- OptimisationBudgetOut[]
  - `meter` string, required
  - `monthly_cap` string, required
  - `default` boolean, required
  - `spent` string, required
  - `reserved` string, required
  - `tier` string, required
  - `default_cap` string, required
  - `set_by` string, nullable, required
  - `set_at` string, date-time, nullable, required

---

[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/af32cd4f14bb?raw)