Chuyển đến nội dung chính
PUT
/
api
/
token
curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "group": "",
    "cross_group_retry": false
  }'
{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt

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

Sử dụng endpoint này để cập nhật tên, trạng thái, quota, thời hạn hết hạn, giới hạn model, danh sách IP cho phép và cài đặt nhóm của một API key.
Tạo personal access token tại Console → Personal Settings, sau đó gửi nó dưới dạng giá trị thô của header Authorization. Không thêm tiền tố Bearer.
Endpoint này sử dụng PUT /api/token/, và id phải nằm trong phần thân JSON. Hãy gửi các trường có thể chỉnh sửa mà bạn muốn giữ nguyên; các trường kiểu số, boolean hoặc chuỗi bị bỏ qua có thể bị đặt lại khi cập nhật.

​
Request body

FieldTypeDescription
idintegerBắt buộc. ID API key được trả về bởi List API keys.
namestringTên hiển thị mà người dùng có thể đọc được cho key. Phải có tối đa 50 ký tự.
statusintegerTrạng thái hoạt động. 1 bật key cho các yêu cầu model. 2 vô hiệu hóa key. 3 đánh dấu là đã hết hạn. 4 đánh dấu là đã hết quota. Các key bị vô hiệu hóa, hết hạn hoặc hết quota sẽ bị các endpoint model từ chối.
expired_timeintegerUnix timestamp tính bằng giây khi key hết hạn. Dùng -1 nếu không hết hạn. Một timestamp trong quá khứ sẽ chặn các yêu cầu model.
remain_quotaintegerQuota còn lại theo đơn vị quota nội bộ của CometAPI. Nếu giá trị này đạt 0 và unlimited_quota là false, các yêu cầu model dùng key này sẽ bị từ chối do hết quota.
unlimited_quotabooleanKey có bỏ qua kiểm tra quota còn lại hay không. Chỉ đặt true khi key cần tiếp tục hoạt động ngay cả khi remain_quota là 0.
model_limits_enabledbooleanCó giới hạn key này chỉ cho các model cụ thể hay không. Khi là false, model_limits sẽ bị bỏ qua.
model_limitsstringCác model ID được phép dùng với key này, phân tách bằng dấu phẩy khi model_limits_enabled là true. Sử dụng model ID được trả về từ /v1/models; dùng chuỗi rỗng nếu không giới hạn model.
allow_ipsstring or nullDanh sách IP cho phép, không bắt buộc. Cung cấp một chuỗi JSON với các mục được phân tách bằng ký tự xuống dòng (\n). Mỗi mục có thể là một địa chỉ IPv4 đơn lẻ, địa chỉ IPv6 đơn lẻ, IPv4 CIDR hoặc IPv6 CIDR. Dùng null hoặc "" để tắt giới hạn IP.
groupstringGiới hạn nhóm tài khoản, không bắt buộc. Dùng chuỗi rỗng nếu không chỉ định nhóm cụ thể. Các giá trị không rỗng phải khả dụng cho tài khoản, nếu không API sẽ trả về success: false.
cross_group_retrybooleanCó bật thử lại liên nhóm để định tuyến nhóm tự động hay không. Trường này chỉ có ý nghĩa khi key sử dụng một nhóm được định tuyến tự động.

​
Allowlist format

Để cho phép nhiều IP hoặc dải CIDR, hãy gửi chúng dưới dạng một chuỗi JSON với \n giữa các mục: 
{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
Ví dụ này cho phép một địa chỉ IPv4, một dải IPv4 CIDR và một dải IPv6 CIDR.

Ủy quyền

​
Authorization
string
header
bắt buộc

Personal access token copied from CometAPI Console > Personal Settings. Send the raw token value; do not prefix it with Bearer.

Nội dung

application/json
​
id
integer
bắt buộc

Numeric API key ID returned by the list endpoint. For updates, send this value in the JSON body, not in the URL.

Ví dụ:

1234

​
name
string

User-readable display name for the API key. The backend accepts up to 50 Unicode characters; longer names return success: false with token name is too long.

Maximum string length: 50
Ví dụ:

"production"

​
status
enum<integer>

Operational status for the key. 1 enables the key for model requests, 2 disables it, 3 marks it expired, and 4 marks it quota exhausted. Disabled, expired, or exhausted keys are rejected by model endpoints.

Tùy chọn có sẵn:
1,
2,
3,
4
Ví dụ:

1

​
expired_time
integer

Unix timestamp in seconds when the key expires. Use -1 for no expiration. A past timestamp blocks model requests with this key.

Ví dụ:

-1

​
remain_quota
integer

Remaining quota to assign to the key in CometAPI internal quota units. If this reaches 0 while unlimited_quota is false, model requests with this key are rejected as quota exhausted.

Ví dụ:

100000

​
unlimited_quota
boolean

Whether the key bypasses remaining-quota checks. Set true only when the key should keep working even if remain_quota is 0.

Ví dụ:

false

​
model_limits_enabled
boolean

Whether to restrict this key to specific models. When true, only model IDs listed in model_limits are allowed. When false, model_limits is ignored.

Ví dụ:

false

​
model_limits
string

Comma-separated model IDs allowed by this key when model_limits_enabled is true. Use model IDs returned by /v1/models, for example <model-id-1>,<model-id-2>. Use an empty string for no model restriction.

Ví dụ:

""

​
allow_ips
string | null

Optional IP allowlist. Provide one JSON string with entries separated by newline characters (\n). Each entry can be a single IPv4 address, single IPv6 address, IPv4 CIDR, or IPv6 CIDR. Example for three allowlist entries: 198.51.100.10\n203.0.113.0/24\n2001:db8::/32. CometAPI compares the model request client IP to this list. Use null or "" to disable IP restrictions.

Ví dụ:

"198.51.100.10\n203.0.113.0/24\n2001:db8::/32"

​
group
string

Optional account group restriction. Use an empty string for no explicit group restriction. Non-empty values must be available to the account, or the API returns success: false with a no access to group message.

Ví dụ:

""

​
cross_group_retry
boolean

Whether cross-group retry is enabled for automatic group routing. This is only meaningful when the key uses an auto-routed group such as auto.

Ví dụ:

false

Phản hồi

200 - application/json

Updated API key record.

​
success
boolean
bắt buộc
​
message
string
bắt buộc
​
data
object
bắt buộc