Cockpit budget status

GET

https://localhost:8080/api/v1/cockpit/budget-status

Virtual key and optional entity-level budget usage for the authenticated VK. Spent totals call Collector with the same Authorization (Bearer vk-…) as this request.

Query parameters

periodstringOptional

Window for spent aggregation: 30d (default), billing_cycle, 7d, 24h

Response

data_sourcestring

degradedboolean

entity_budgetobject

messagestring

virtual_key_budgetobject

Errors

401

Unauthorized Error

1	{
2	"data_source": "string",
3	"degraded": true,
4	"entity_budget": {
5	"budget_cents": 1,
6	"spent_cents": 1,
7	"usage_pct": 1.1
8	},
9	"message": "string",
10	"virtual_key_budget": {
11	"budget_action": "string",
12	"budget_cents": 1,
13	"budget_window": "string",
14	"remaining_cents": 1,
15	"resets_at": "string",
16	"spent_cents": 1,
17	"usage_pct": 1.1
18	}
19	}

1	curl https:https://localhost:8080/api/v1/cockpit/budget-status \
2	-H "Authorization: Authorization"

Headers

Query parameters

Response

Errors