Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

Get API key spend limits

Returns your spending limits for this API key, plus how much of your daily and monthly budget you have used.

GET/v1/limits
Responses
200Current API key spend policy and budget-window usage
dataobjectrequired
Show properties
policyobjectrequired
Show properties
max_credits_per_requestintegerrequired
min 0
approval_threshold_creditsintegerrequired
min 0
allowed_modelsstring[] | nullrequired
max items 200
dailyobjectrequired
Show properties
limitintegerrequired
min 0
usedintegerrequired
min 0
remainingintegerrequired
min 0
reset_atstring<date-time>required
monthlyobjectrequired
Show properties
limitintegerrequired
min 0
usedintegerrequired
min 0
remainingintegerrequired
min 0
reset_atstring<date-time>required
503The authoritative spend-limit snapshot is unavailable
errorobjectrequired
Show properties
codestringrequired
min length 1 · max length 128
messagestringrequired
min length 1 · max length 2000
retryablebooleanrequired
request_idstring<uuid>required
balanceinteger
min 0
requiredinteger
min 0
fieldstring
min length 1 · max length 512
statestring
min length 1 · max length 128
retryWithNewKeyboolean
parameterstring
min length 1 · max length 128
allowedstring[]
max items 100
Request
curl -X GET "https://api.roasos.com/v1/limits"
Response
{
  "data": {
    "policy": {
      "max_credits_per_request": 0,
      "approval_threshold_credits": 0,
      "allowed_models": [
        "string"
      ]
    },
    "daily": {
      "limit": 0,
      "used": 0,
      "remaining": 0,
      "reset_at": "2024-01-01T00:00:00Z"
    },
    "monthly": {
      "limit": 0,
      "used": 0,
      "remaining": 0,
      "reset_at": "2024-01-01T00:00:00Z"
    }
  }
}