Skip to content
Evershell Docs

Current budget counters for a workspace

GET
/workspaces/{id}/budgets
 
curl --request GET \
  --url https://your-org.evershell.ai/v1/workspaces/example/budgets \
  --header 'Authorization: Bearer <token>'

Permissions: workspace:read or workspace:read:own (creator-match on :own).

Returns every budget counter the workspace’s role + caps.yaml declares, with the live used / reserved / max / remaining snapshot. max: 0 means unlimited.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
workspace_id
required
string
budgets
required
Array<object>
object
capability_name
required
string
counter_name
string
used
required
integer format: int64
reserved
required
integer format: int64
max
required

0 means unlimited.

integer format: int64
remaining
required
integer format: int64
Example generated
{
  "workspace_id": "example",
  "budgets": [
    {
      "capability_name": "example",
      "counter_name": "example",
      "used": 1,
      "reserved": 1,
      "max": 1,
      "remaining": 1
    }
  ]
}

404

Section titled “404 ”

Resource not found in the caller’s org

Media type application/json
object
error
required
object
code
required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string
message
required

Human-readable summary

string
request_id
required

Server-generated request id for correlating logs

string
details

Optional structured context. Validation errors land at details.fields as a per-field map.

object
key
additional properties
any
Example 
{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}