Skip to main content

RateLimitsDocsResponse

apiKeyTransactionLimit object
anyOf

Documentation block describing the per-API-key spend cap.

This is intentionally distinct from the per-window rate-limits exposed via defaults / endpoints above. It exists because callers historically conflated the two: until 2026-05 both signals surfaced as HTTP 429 LIMIT_REACHED, leading to misguided client-side back-off against a static spend cap that does not "free up" with time.

Now:

  • Per-window rate limits — HTTP 429 LIMIT_REACHED. Retry with back-off once the window resets.
  • Per-API-key transaction limit — HTTP 409 API_KEY_LIMIT_EXCEEDED with errorCode='api_key_transaction_limit_exceeded'. Cannot be resolved by retrying; the cap must be raised (or transactionUsed reset) through the control plane.
descriptionDescriptionrequired
enforcedOnstring[]required
errorCodeErrorcoderequired
httpStatusHttpstatusrequired
remediationRemediationrequired
retryableRetryablerequired
statusCodeStatuscoderequired
defaults objectrequired
limitLimitrequired
windowSecondsWindowsecondsrequired
endpoints object[]required
  • Array [
    • keyKeyrequired
    limitLimitrequired
    methodMethodrequired
    pathPathrequired
    sourceSourcerequired

    Possible values: [default, rule, override]

    windowSecondsWindowsecondsrequired
  • ]
    • RateLimitsDocsResponse
    {
      "apiKeyTransactionLimit": {
        "description": "string",
        "enforcedOn": [
          "string"
        ],
        "errorCode": "string",
        "httpStatus": 0,
        "remediation": "string",
        "retryable": true,
        "statusCode": 0
      },
      "defaults": {
        "limit": 0,
        "windowSeconds": 0
      },
      "endpoints": [
        {
          "key": "string",
          "limit": 0,
          "method": "string",
          "path": "string",
          "source": "default",
          "windowSeconds": 0
        }
      ]
    }