Whether a send or call of this size fits right now, without using anything

post/usage/limits/check

Whether a send or call of this size fits right now, without using anything. When it does not, the plain reason and the next step. Ask before a large send.

Before you call

Credential: Authorization: Bearer $KEY
Scope: usage:read
Mcp: rivier_usage_limit_check
Graphql: Query.usageLimitCheck
Sdk: usage.limit.check
Cli: usage limit check

Request bodyapplication/json, required

meterstringrequired
At most 80 characters.
qtyinteger
Default: 1. At least 1. At most 1000000.

Responses

200application/json
Success
- okbooleanrequired
- modestring
- refusalobject
  - codestringrequired
  - meterstringrequired
  - labelstringrequired
  - reasonstringrequired
  - usednumberrequired
  - limitnumberrequired
  - remainingnumberrequired
  - resetsAtstring or nullrequired
  - policystringrequired
    One of: block, bill, approve.
  - nextobjectrequired
    - actionstringrequired
      One of: upgrade, topup, raise_cap, approve, wait.
    - routestringrequired
    - hintstringrequired
    - approvalIdstring
    - resetsAtstring or null
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/usage/limits/check' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "meter": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown