Look up a single budget by exact scope and unit
Returns a single budget ledger matching the exact (scope, unit) pair. Unlike listBudgets which uses scope_prefix (prefix match), this endpoint performs exact scope matching — the budget is uniquely identified by the (scope, unit) pair.
AUTHORIZATION: - ApiKeyAuth: scope_filter is enforced; only accessible if scope matches key's filter. - AdminKeyAuth: Accepted as alternative (dual-auth).
No tenant_id required — the budget is uniquely identified by (scope, unit).
Authorizations
Tenant-scoped API key for runtime operations (consistent with Cycles Protocol)
Administrative API key with full system access. Also accepted as an alternative to ApiKeyAuth on an explicit per-operation allowlist — the authoritative list is the union of operations whose security: block declares AdminKeyAuth (consult per-operation security blocks rather than this prose, which has historically drifted as the dual-auth surface expanded). When using AdminKeyAuth on list or fund endpoints, a tenant scoping parameter (typically tenant or tenant_id) is required for scoping (400 if missing) — the per-operation description specifies which. Lookup-style endpoints that uniquely identify a resource by non-tenant key (e.g. GET /v1/admin/budgets/lookup, where the (scope, unit) pair is unique) do NOT require a tenant parameter. Allowlisting is per-operation (exact method:path matching — no prefix matching, no wildcards) so new endpoints do not accidentally inherit admin-accessible status.
Parameters
Query Parameters
Exact canonical scope identifier, e.g., "tenant:acme/workspace:prod"
"USD_MICROCENTS""TOKENS""CREDITS""RISK_POINTS"Responses
Budget ledger found