v126

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-04957391.2 MB

API Keys

Update an API key

Update an existing API key. Management key required.

patch/keys/{hash}

Path parameters

hashstring required

The hash identifier of the API key to update

Example:f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943

The hash identifier of the API key to update

Request body

disabledboolean

Whether to disable the API key

include_byok_in_limitboolean

Whether to include BYOK usage in the limit

limitnumber double nullable

New spending limit for the API key in USD

limit_reset'daily' | 'weekly' | 'monthly' | 'null' nullable

New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.

namestring

New name for the API key

Example request

{
  "disabled": false,
  "include_byok_in_limit": true,
  "limit": 75,
  "limit_reset": "daily",
  "name": "Updated API Key Name"
}

Response

API key updated successfully

Example response

{
  "data": {
    "byok_usage": 17.38,
    "byok_usage_daily": 17.38,
    "byok_usage_monthly": 17.38,
    "byok_usage_weekly": 17.38,
    "created_at": "2025-08-24T10:30:00Z",
    "creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
    "disabled": false,
    "expires_at": null,
    "hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
    "include_byok_in_limit": true,
    "label": "Updated API Key Name",
    "limit": 75,
    "limit_remaining": 49.5,
    "limit_reset": "daily",
    "name": "Updated API Key Name",
    "updated_at": "2025-08-24T16:00:00Z",
    "usage": 25.5,
    "usage_daily": 25.5,
    "usage_monthly": 25.5,
    "usage_weekly": 25.5,
    "workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
  }
}