The caller's current budget status (effective cap + spend this cycle)

GET

api

budget

curl --request GET \
  --url https://3ngram-server-production.up.railway.app/api/v1/budget \
  --header 'X-API-Key: <api-key>'

{
  "capUsdOverride": 123,
  "consumedUsd": 123,
  "effectiveCapUsd": 123,
  "periodEnd": "<string>",
  "periodStart": "<string>"
}

X-API-Key

string

header

required

200 - application/json

Success

capUsdOverride

number | null

required

consumedUsd

number

required

effectiveCapUsd

number

required

periodEnd

string | null

required

periodStart

string | null

required

The caller's current budget status (effective cap + spend this cycle)

curl --request GET \
  --url https://3ngram-server-production.up.railway.app/api/v1/budget \
  --header 'X-API-Key: <api-key>'

{
  "capUsdOverride": 123,
  "consumedUsd": 123,
  "effectiveCapUsd": 123,
  "periodEnd": "<string>",
  "periodStart": "<string>"
}