Skip to main content
GET
Get a workspace budget

Authorizations

Authorization
string
header
required

A Nemonist key (sk-nm-...) as a bearer token in the Authorization header.

Headers

HTTP-Referer
string

The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application.

X-OpenRouter-Title
string

The app display name allows you to customize how your app appears in OpenRouter's dashboard.

X-OpenRouter-Categories
string

Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.

Path Parameters

workspace_ref
string
required

The workspace ID or slug

Minimum string length: 1
Example:

"production"

interval
enum<string>
required

Budget reset interval. Use "lifetime" for a one-time budget that never resets.

Available options:
daily,
weekly,
monthly,
lifetime
Example:

"monthly"

Response

Budget retrieved successfully

data
object
required

The workspace's budget.

Example:
include_byok_in_budgets
boolean

Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime).

Example:

true