budgets.listBudgets

GET

/v1/organization/budgets

const url = 'https://example.com/v1/organization/budgets';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/organization/budgets \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Responses

200

Success

application/json

object

items

required

Array<object>

object

required

string

scope

required

string

Allowed values: organization member agent token

scopeId

required

string

period

required

string

Allowed values: day month

limitMicros

required

integer

<= 9007199254740991

mode

required

string

Allowed values: hard soft

periodStart

required

string

spentMicros

required

integer

<= 9007199254740991

exceeded

required

boolean

version

required

integer

<= 9007199254740991

createdAt

required

string

updatedAt

required

string

Example

{
  "items": [
    {
      "scope": "organization",
      "period": "day",
      "mode": "hard"
    }
  ]
}

400

UsageQueryInvalid | BudgetInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: UsageQueryInvalid

message

required

string

Example

{
  "_tag": "UsageQueryInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

BudgetNotFound

application/json

object

_tag

required

string

Allowed values: BudgetNotFound

budgetId

required

string

Example

{
  "_tag": "BudgetNotFound"
}

409

BudgetConflict

application/json

object

_tag

required

string

Allowed values: BudgetConflict

message

required

string

Example

{
  "_tag": "BudgetConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

AuthorizationUnavailable | BillingUnavailable | AuthenticationUnavailable

application/json

Any of:

object

_tag

required

string

Allowed values: AuthorizationUnavailable

Example

{
  "_tag": "AuthorizationUnavailable"
}