Start free →

API reference

Usage, spend and footprint

Read the usage traces, the spend and savings report, the budgets and their use, and the estimated energy and carbon footprint.

All of the API reference

Route summaries and field names are written in English, here and in the file.

/api/v1/usage

GET /api/v1/usage

The workspace's usage traces, newest first (paginated)

Authentication
API key
Key scope
usage:read
Parameters
limit · offset · cursor · since · model · agentId · status

/api/v1/report

GET /api/v1/report

The spend and savings report of the workspace

Authentication
API key
Key scope
usage:read
Parameters
days · subscriptionCostUsd

/api/v1/budgets

GET /api/v1/budgets

The workspace's budgets and their use

Authentication
API key
Key scope
budgets:read

/api/v1/greenops

GET /api/v1/greenops/footprint

The workspace's estimated energy and carbon footprint, over an API key

Authentication
API key
Key scope
usage:read
Parameters
periodDays

GET /api/v1/greenops/energy

Energy per day and per strategy, and the workspace's energy budget

Authentication
API key or signed-in session
Parameters
workspaceId · days · feature

GET /api/v1/greenops/summary

GreenOps key figures (the dashboard's read)

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays

GET /api/v1/greenops/carbon

Estimated carbon totals and their monthly trend (the dashboard's read)

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays · months

GET /api/v1/greenops/provider-efficiency

Energy per 1,000 tokens, per provider and model (the dashboard's read)

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays

GET /api/v1/greenops/replay-savings

Energy saved by reusing answers (the dashboard's read)

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays

GET /api/v1/greenops/abatement

Avoided CO₂ with its traceability (the dashboard's read)

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays

GET /api/v1/greenops

Deprecated — Deprecated: use /api/v1/greenops/summary

Authentication
Signed-in session (the dashboard)
Parameters
workspaceId (required) · periodDays