NylorunDocsBeta
Management APIModelsUsage and budgets

Get the Tenant's model budgets

GET
/v1/tenant/budgets

Authorization

managementKey
headerAuthorizationBearer <token>

A management key of the Tenant (role management): it reaches the Management API (/v1/tenant/*) and /v1/me, as itself, never for a subject. Issued only on the Tenant's machine (nylorun-operate keys put <id> --role management) or from NYLORUN_MANAGEMENT_KEY_FILE. Never accepted from a browser (Origin).

Header Parameters

Nylorun-Protocol*string

The protocol version, 8

Response Body

The hard caps on model spend

application/json
  1. response
budgets*array<>
import { createAdmin } from "@nylorun/admin";const admin = createAdmin();const budgets = await admin.models.budgets.get();
{  "budgets": [    {      "scope": "tenant",      "id": "string",      "period": "day",      "limitUsd": 1,      "limitTokens": 1    }  ]}

Export committed model calls in safe transaction order GET

Previous Page

Set the Tenant's model budgets PUT

Replaces every budget. Before each model call the gate checks the scope's spend against its cap; once a cap is reached the call fails with `budget_exhausted` and the turn with `model.budget_exhausted`. An empty list removes every cap.