PATCH /api/circles/{circle_id}/budget

PATCH /api/circles/{circle_id}/budget

Update Budget

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

Name	In	Type	Required	Description
`circle_id`	path	string	Yes	-
`X-Org-ID`	header	string \| null	No	-

Request body

A JSON request body is required.

Field	Type	Required	Description
`budget_tokens_monthly`	integer \| null	No	-

Example request

curl -X PATCH https://api.cognitivx.io/api/circles/{circle_id}/budget \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "budget_tokens_monthly": null
  }'

Example response

200 application/json

{
  "budget_tokens_monthly": 1,
  "budget_used_tokens": 1,
  "budget_remaining": 1,
  "budget_pct_used": 0,
  "budget_month": "string",
  "last_warning_level": 1
}

Responses

Status	Description
`200`	Success. Returns the response body shown below.
`422`	Request validation failed. `detail` lists each offending field.