Update API Key

Use an access token generated on the profile page, not the model API Key being managed. See Programmatic API Key management for credentials and the full workflow.

Quota conversion: remain_quota = amount * 500000. expired_time=-1 means never expires; remain_quota=-1 with unlimited_quota=true means unlimited quota.

An ordinary update may reset omitted configuration. Read the details first and retain expiry, quota, and other settings before submitting.

Configuration and status-only updates share an endpoint. For status only, set status_only=true and send only id and status. The example includes the query parameter; configure it explicitly in Try It too.

PUT/api/token/

Update configuration or status. Ordinary updates may reset omitted fields; read details first and retain required settings. For status only, set status_only=true and submit id/status.

Authorization

userAccessToken

AuthorizationBearer <token>

Create an access token under Profile → Security. Use Bearer authentication, not a model API Key.

In: header

Query Parameters

status_only?boolean

Whether to update status only.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Ordinary updates may reset omitted configuration. Read details first and resubmit settings to retain. Use status_only=true for status-only updates.

name?string

Token name.

expired_time?integer

Unix expiry in seconds; -1 means never expires.

remain_quota?integer

Remaining quota: remain_quota = amount * 500000. -1 together with unlimited_quota=true means unlimited quota.

unlimited_quota?boolean

Whether quota is unlimited.

model_limits_enabled?boolean

Whether model restrictions are enabled.

model_limits?string

Allowed model IDs separated by commas; do not send an array.

allow_ips?string

Allowed IP addresses, separated by commas.

group?string

Assigned group.

id*integer

Token ID, required.

status?integer

New status when updating status only, for example 1.

Response Body

`application/json`

curl -X PUT "https://example.com/api/token/" \
  -H "Authorization: Bearer your-user-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 123,
    "name": "Updated Token",
    "expired_time": -1,
    "remain_quota": 2000000,
    "unlimited_quota": false,
    "model_limits_enabled": true,
    "model_limits": "MODEL_ID",
    "allow_ips": "192.168.1.1",
    "group": "vip"
  }'

{
  "success": true,
  "message": "",
  "data": {
    "id": 123,
    "name": "Updated API Key",
    "key": "sk-****example",
    "status": 1,
    "remain_quota": 0,
    "unlimited_quota": false,
    "expired_time": 1792598400,
    "created_time": 1792512000,
    "accessed_time": 0,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": "",
    "used_quota": 0,
    "group": "",
    "quota_reset_period": "",
    "quota_reset_amount": 0,
    "quota_reset_timezone": "",
    "quota_reset_time": "",
    "quota_reset_weekday": 0,
    "next_quota_reset_at": 0,
    "last_quota_reset_at": 0,
    "quota_reset_version": 0,
    "model_route_enabled": false,
    "model_route_char": "",
    "strong_affinity_enabled": false,
    "auto_groups": null,
    "DeletedAt": null
  }
}

Authorization

Query Parameters

Request Body

Response Body

200application/json

401application/json

`application/json`

`application/json`