Skip to content
OpenBot

budgets.createBudget

POST
/v1/organization/budgets
curl --request POST \
  --url https://example.com/v1/organization/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "organization", "scopeId": "example", "period": "day", "limitMicros": 1, "mode": "hard" }'

Adds a budget. Each scope can have one budget for each period.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
scope
required
string
Allowed values: organization member agent token
scopeId
string
>= 1 characters <= 200 characters
period
required
string
Allowed values: day month
limitMicros
required
integer
<= 9007199254740991
mode
required
string
Allowed values: hard soft

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
id
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 

{
  "scope": "organization",
  "period": "day",
  "mode": "hard"
}

400

Section titled “400”

UsageQueryInvalid | BudgetInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: UsageQueryInvalid
message
required
string

Example 

{
  "_tag": "UsageQueryInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/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

Section titled “404”

BudgetNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: BudgetNotFound
budgetId
required
string

Example 

{
  "_tag": "BudgetNotFound"
}

409

Section titled “409”

BudgetConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: BudgetConflict
message
required
string

Example 

{
  "_tag": "BudgetConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | BillingUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}