Skip to main content
PATCH
/
keys
/
{id}
Update an API key
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    scopes: '["chat.completions","responses"]',
    limit: 1,
    limit_reset: 'daily',
    include_byok_in_limit: true,
    expires_at: '2023-11-07T05:31:56Z',
    disabled: true,
    soft_blocked: true
  })
};

fetch('https://api.phaseo.app/v1/keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "hash": "a3f5b7c9d8e1f23456789abcdeffedcba9876543210fedcba1234567890abcdef",
    "workspace_id": "22222222-2222-4222-8222-222222222222",
    "name": "Analytics Service Key",
    "label": "Analytics Service Key",
    "prefix": "aistats_v1_sk_abcd1234",
    "status": "active",
    "disabled": false,
    "soft_blocked": false,
    "scopes": "[\"chat.completions\",\"responses\"]",
    "created_by": "user_abc123",
    "created_at": "2026-04-28T12:00:00Z",
    "updated_at": "2026-04-28T12:15:00Z",
    "last_used_at": "2026-04-28T12:30:00Z",
    "expires_at": "2027-12-31T23:59:59Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ai-stats.phaseo.app/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint requires a management API key. Standard Gateway API keys are not accepted.
Use this endpoint to rename a key, adjust scopes, set expiry, disable it, or set a spend limit with limit and limit_reset.

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

API key identifier or hash.

Body

application/json
name
string
Minimum string length: 1
scopes
Example:

"[\"chat.completions\",\"responses\"]"

limit
number | null

Optional spend limit in USD for this key. Set null to clear.

Required range: x >= 0
limit_reset
enum<string>

Period used for the spend limit window.

Available options:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Accepted for compatibility. Current AI Stats behavior always excludes BYOK from this limit field.

expires_at
string<date-time> | null
disabled
boolean
soft_blocked
boolean

Response

Updated API key metadata

data
object
required
Last modified on April 29, 2026