Sign in
scoped-budgets

Create Scoped Budget

Changed on

Create a scoped budget.

Answers 404 when the scope names nothing, rather than creating a ceiling that can never bind.

post/api/v1/scoped-budgets

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

budget_idstring required

The budget this ceiling enforces; its limit and period are read through it

namestring nullable

Admin-facing label for this ceiling

provider_key_idstring nullable

Narrow the cap to one provider instance; omit or null to cap spend across every provider. A blank value would store a ceiling that never binds, so it is refused; this does not check that the value names a configured provider instance

scope_idstring required

Id of the capped identity: an organization, workspace, membership row, or API key

scope_type'organization' | 'workspace' | 'workspace_member' | 'org_member' | 'api_token' required

Which kind of identity this ceiling caps

Response

Successful Response

budget_duration_secinteger nullable required
budget_idstring required
created_atstring required
current_requestsinteger required
current_spendnumber required
current_tokensinteger required
idstring required
max_budgetnumber nullable required
namestring nullable required
period_endstring nullable required
period_startstring nullable required
provider_key_idstring nullable required
request_limitinteger nullable required
reserved_requestsinteger required
reserved_spendnumber required
reserved_tokensinteger required
reset_alignmentstring nullable required
scope_idstring required
scope_typestring required
token_limitinteger nullable required
updated_atstring required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id create_scoped_budget_api_v1_scoped_budgets_post removed and replaced with scoped-budgets-create_scoped_budget