# Update an API key

Update an API key. Fields and permissions follow this gateway implementation.

## Endpoint and authentication

`PUT https://api.tu-zi.com/api/token/`

Transport: json

Use an account system token and New-Api-User (account ID), or a valid site login session. Manage system tokens in account settings. Inference API keys are not substitutes.

Authorized OAuth access tokens are also supported; required scope: `token:write`

```http
Authorization: Bearer YOUR_SYSTEM_TOKEN
New-Api-User: YOUR_USER_ID
Content-Type: application/json
```

## Query parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| status_only | string | No | A nonempty value updates only status. |

## Body parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| id | integer | Yes | Token ID. Example: 123 |
| status | integer | No | In status_only mode use 1 to enable or 2 to disable. Example: 2 |
| name | string | No | Name, up to 50 bytes. Example: demo |
| expired_time | integer | No | Unix seconds; -1 means no expiry. Set explicitly. Example: -1 |
| remain_quota | integer | No | Initial quota, nonnegative. Example: 1000 |
| unlimited_quota | boolean | No | Unlimited quota. Example: false |
| remain_count | integer | No | Request-count limit; 0 means unlimited. Example: 0 |
| group | string | No | Authorized groups, comma separated. Example:  |
| model_limits_enabled | boolean | No | Enable model restrictions. Example: false |
| model_limits | string | No | Comma-separated model IDs. Example:  |
| allow_ips | string | No | Allowed IP/CIDR, one per line. Example:  |
| exclude_ips | string | No | Blocked IP/CIDR, one per line. Example:  |
| cross_group_retry | boolean | No | Cross-group retry setting. Example: false |
| routing_preference | string | No | price or quality. Example: price |
| routing_quality_threshold | integer | No | 30, 40, 50, 60, 70, 80, 85, 90, 95. Example: 70 |
| mj_mode | string | No | Midjourney mode; omitted uses site default. Example: 默认 |
| rate_limits_enabled | boolean | No | Enable token rate limits. Example: false |
| rate_limits_time | integer | No | Rate-limit window in seconds; effective when enabled and both time and count are positive. Example: 0 |
| rate_limits_count | integer | No | Rate-limit request count. Example: 0 |
| rate_limits_content | string | No | Message returned when the token rate limit is reached; empty uses the default message. Example:  |

## Minimal request example

```json
{
  "id": 123,
  "status": 2
}
```

## Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Set SYSTEM_TOKEN and USER_ID in the environment; keep system tokens out of frontend code. Replace YOUR_SYSTEM_TOKEN and YOUR_USER_ID in cURL.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

## Code examples

### curl

```bash
curl --request PUT 'https://api.tu-zi.com/api/token/?status_only=true' \
  --header 'Authorization: Bearer YOUR_SYSTEM_TOKEN' \
  --header 'New-Api-User: YOUR_USER_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "status": 2
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/api/token/?status_only=true"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_SYSTEM_TOKEN\",\"New-Api-User\":\"YOUR_USER_ID\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["SYSTEM_TOKEN"]
headers["New-Api-User"] = os.environ["USER_ID"]
payload = json.loads("{\"id\":123,\"status\":2}")
response = requests.request("PUT", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
// Node.js 20+
const url = "https://api.tu-zi.com/api/token/?status_only=true";
const headers = {
  "Authorization": "Bearer YOUR_SYSTEM_TOKEN",
  "New-Api-User": "YOUR_USER_ID",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.SYSTEM_TOKEN;
headers['New-Api-User'] = process.env.USER_ID;
const response = await fetch(url, { method: "PUT", headers, body: JSON.stringify({
  "id": 123,
  "status": 2
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## Response fields

| Field | Type | Description / constraints |
| --- | --- | --- |
| success | boolean | Business success; do not rely only on HTTP status. |
| message | string | Result or error message. |
| data | object | Token configuration with a masked key. |
| data.is_expired | boolean | Whether expired. |

Illustrative response; some endpoints show essential fields only. Optional fields may be absent.

```json
{
  "success": true,
  "message": "",
  "data": {
    "id": 123,
    "name": "demo",
    "key": "sk-****",
    "remain_quota": 1000,
    "unlimited_quota": false,
    "expired_time": -1,
    "is_expired": false
  }
}
```

## Errors and retries

Check HTTP status and success. Business validation errors may return HTTP 200 with {"success":false,"message":"..."}; some include error.code. Authentication may return 401/403 and rate limiting 429. HTTP 200 alone does not guarantee success.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

## Constraints

The example only disables a key. Without status_only this updates configuration: omitted ordinary fields take zero values. Read existing configuration and submit fields to preserve. Do not treat PUT as PATCH.

## Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-token-update

This export contains documentation and examples only, without real credentials, account data or user requests.