Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

product
string
required

Product the limit applies to, as returned in product by the list operation.

Example:

"inference"

Query Parameters

period
enum<string>
default:daily

Limit period. Defaults to daily; send it explicitly. daily is the current UTC day; monthly is the current UTC calendar month.

Available options:
daily,
monthly
Example:

"daily"

credential_id
string

Identifier of one API key as recorded on usage, never the key's secret, percent-encoded: the request is then about that key's limit. Absent means the total limit; present but blank is refused.

Required string length: 1 - 255
Example:

"KEY0192F3A1B2C3D4E5F6A7B8C9D0E1F2"

Body

application/json

Send exactly one of amount and unlimited: true.

amount
number
required

Limit in USD. 0 blocks at the first cent of spend.

Required range: x >= 0
Example:

100

unlimited
enum<boolean>

Optional; only false is allowed together with amount.

Available options:
false
Example:

false

reason
string

Why the limit is set or changed, kept for audit.

Maximum string length: 500
Example:

"Raised for the product launch"

Response

The limit was updated. evaluation says whether the change lifted or started a block.

data
object
required

The spend limit, spend and block state of one product and period. The top-level fields describe the total limit of the account; API key limits are nested in credential_limits.