credit-limits

Set a monthly credit limit for an API key

Changed on
put/credit-limits/api-keys/{apiKeyId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

apiKeyIdstring required

Request body

monthlyCreditsnumber required

The monthly credit allowance. 0 freezes the target entirely; remove the limit to make the target unlimited within the org budget.

Example request

{
  "monthlyCredits": 5000
}

Response

idstring required
monthlyCreditsnumber required
apiKeyIdstring required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "monthlyCredits": 5000,
  "apiKeyId": "550e8400-e29b-41d4-a716-446655440003"
}

Changes