For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workspace member budget policies

List Workspace Budget Defaults

get

List the budget defaults attached to a workspace. Any member may read it.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Query parameters
skipintegerOptional

Number of records to skip

Default: 0
limitinteger · min: 1 · max: 1000Optional

Maximum number of records to return

Default: 100
Responses
200

Successful Response

application/json
countintegerRequired
get/api/v1/workspaces/{workspace_id}/member-budget-policies
GET /api/v1/workspaces/{workspace_id}/member-budget-policies HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "data": [
    {
      "budget_duration_sec": 1,
      "budget_id": "text",
      "created_at": "text",
      "id": "text",
      "max_budget": 1,
      "name": "text",
      "provider_key_id": "text",
      "request_limit": 1,
      "reset_alignment": "text",
      "token_limit": 1,
      "updated_at": "text",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create Workspace Budget Default

post

Create a budget default.

Materializes it into a per-member scoped_budgets row for every existing active member of the workspace; a member who joins afterwards is materialized when they join.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Body

Request body for creating a default.

budget_idstring · min: 1 · max: 255Required

The budget this workspace hands to every member

provider_key_idstring · min: 1 · max: 255 · nullableOptional

Narrow the default to one provider instance; omit or null to apply to every provider. A blank value would materialize ceilings that never bind, so it is refused; this does not check that the value names a configured provider instance

Pattern: ^\S+$
Responses
201

Successful Response

application/json

One default and its template values.

budget_duration_secinteger · nullableRequired
budget_idstringRequired
created_atstringRequired
idstringRequired
max_budgetnumber · nullableRequired
namestring · nullableRequired
provider_key_idstring · nullableRequired
request_limitinteger · nullableRequired
reset_alignmentstring · nullableRequired
token_limitinteger · nullableRequired
updated_atstringRequired
workspace_idstring · uuidRequired
post/api/v1/workspaces/{workspace_id}/member-budget-policies
POST /api/v1/workspaces/{workspace_id}/member-budget-policies HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "budget_id": "text",
  "provider_key_id": "text"
}
{
  "budget_duration_sec": 1,
  "budget_id": "text",
  "created_at": "text",
  "id": "text",
  "max_budget": 1,
  "name": "text",
  "provider_key_id": "text",
  "request_limit": 1,
  "reset_alignment": "text",
  "token_limit": 1,
  "updated_at": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Update Workspace Budget Default

patch

Update a budget default's label or limit.

Not retroactive: members already materialized from this default keep their existing ceiling; only a member materialized afterwards sees the new one.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
default_idstringRequired
Body

Request body for pointing a default at a different budget.

Members already materialized from this default keep the budget they were given: their ceiling names it directly, and this only changes what a member joining afterwards is handed. Editing the budget is the retroactive act, and it moves everyone naming it, in this workspace and outside it.

budget_idstring · min: 1 · max: 255Required
Responses
200

Successful Response

application/json

One default and its template values.

budget_duration_secinteger · nullableRequired
budget_idstringRequired
created_atstringRequired
idstringRequired
max_budgetnumber · nullableRequired
namestring · nullableRequired
provider_key_idstring · nullableRequired
request_limitinteger · nullableRequired
reset_alignmentstring · nullableRequired
token_limitinteger · nullableRequired
updated_atstringRequired
workspace_idstring · uuidRequired
patch/api/v1/workspaces/{workspace_id}/member-budget-policies/{default_id}
PATCH /api/v1/workspaces/{workspace_id}/member-budget-policies/{default_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "budget_id": "text"
}
{
  "budget_duration_sec": 1,
  "budget_id": "text",
  "created_at": "text",
  "id": "text",
  "max_budget": 1,
  "name": "text",
  "provider_key_id": "text",
  "request_limit": 1,
  "reset_alignment": "text",
  "token_limit": 1,
  "updated_at": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Workspace Budget Default

delete

Delete a budget default.

The per-member scoped_budgets rows it already materialized are kept; a member joining afterwards no longer gets one from it.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
default_idstringRequired
Responses
200

Successful Response

application/json

A human-readable acknowledgment for an operation with nothing to return.

messagestringRequired

What happened.

delete/api/v1/workspaces/{workspace_id}/member-budget-policies/{default_id}
DELETE /api/v1/workspaces/{workspace_id}/member-budget-policies/{default_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "message": "text"
}

Last updated

Was this helpful?