الانتقال إلى المحتوى الرئيسي
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.

استخدم نقطة النهاية هذه لتحديث اسم مفتاح API، وحالته، وحصته، وانتهائه، وقيود النموذج، وقائمة IP المسموح بها، وإعدادات المجموعة.
أنشئ personal access token من Console → Personal Settings، ثم أرسله كقيمة خام لترويسة Authorization. لا تضف إليه السابقة Bearer.
تستخدم نقطة النهاية هذه PUT /api/token/، ويجب وضع id داخل جسم JSON. أرسل الحقول القابلة للتعديل التي تريد الحفاظ عليها؛ إذ يمكن إعادة تعيين الحقول الرقمية أو المنطقية أو النصية المحذوفة عند التحديث.

​
جسم الطلب

الحقلالنوعالوصف
idintegerمطلوب. معرّف مفتاح API الذي يتم إرجاعه بواسطة List API keys.
namestringاسم عرض واضح للمستخدم للمفتاح. يجب ألا يتجاوز 50 حرفًا.
statusintegerالحالة التشغيلية. تؤدي القيمة 1 إلى تفعيل المفتاح لطلبات النموذج. وتؤدي 2 إلى تعطيله. وتشير 3 إلى أنه منتهي الصلاحية. وتشير 4 إلى استنفاد الحصة. يتم رفض المفاتيح المعطلة أو المنتهية أو المستنفدة من قِبل نقاط نهاية النموذج.
expired_timeintegerطابع زمني Unix بالثواني لانتهاء صلاحية المفتاح. استخدم -1 لعدم وجود انتهاء صلاحية. يؤدي الطابع الزمني الماضي إلى حظر طلبات النموذج.
remain_quotaintegerالحصة المتبقية بوحدات الحصة الداخلية في CometAPI. إذا وصلت هذه القيمة إلى 0 وكانت unlimited_quota تساوي false، فسيتم رفض طلبات النموذج بهذا المفتاح على أنها مستنفدة الحصة.
unlimited_quotabooleanما إذا كان المفتاح يتجاوز عمليات التحقق من الحصة المتبقية. اضبطها على true فقط عندما يجب أن يواصل المفتاح العمل حتى إذا كانت remain_quota تساوي 0.
model_limits_enabledbooleanما إذا كان يجب تقييد هذا المفتاح بنماذج محددة. عندما تكون false، يتم تجاهل model_limits.
model_limitsstringmodel IDs مفصولة بفواصل والمسموح بها لهذا المفتاح عندما تكون model_limits_enabled مساوية لـ true. استخدم model IDs المُعادة من /v1/models؛ واستخدم سلسلة فارغة لعدم فرض أي تقييد على النموذج.
allow_ipsstring or nullقائمة سماح IP اختيارية. قدّم سلسلة JSON واحدة مع فصل الإدخالات بأحرف السطر الجديد (\n). يمكن أن يكون كل إدخال عنوان IPv4 واحدًا، أو عنوان IPv6 واحدًا، أو IPv4 CIDR، أو IPv6 CIDR. استخدم null أو "" لتعطيل قيود IP.
groupstringتقييد اختياري لمجموعة الحساب. استخدم سلسلة فارغة عند عدم وجود مجموعة محددة صراحةً. يجب أن تكون القيم غير الفارغة متاحة للحساب، وإلا ستُرجع API القيمة success: false.
cross_group_retrybooleanما إذا كان إعادة المحاولة عبر المجموعات مفعّلًا للتوجيه التلقائي للمجموعة. يكون هذا ذا معنى فقط عندما يستخدم المفتاح مجموعة ذات توجيه تلقائي.

​
تنسيق قائمة السماح

للسماح بعدة عناوين IP أو نطاقات CIDR، أرسلها كسلسلة JSON واحدة مع \n بين الإدخالات: 
{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
يسمح هذا المثال بعنوان IPv4 واحد، ونطاق IPv4 CIDR واحد، ونطاق IPv6 CIDR واحد.

التفويضات

​
Authorization
string
header
مطلوب

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

الجسم

application/json
​
id
integer
مطلوب

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

مثال:

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
مثال:

"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.

الخيارات المتاحة:
1,
2,
3,
4
مثال:

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.

مثال:

-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.

مثال:

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.

مثال:

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.

مثال:

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.

مثال:

""

​
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.

مثال:

"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.

مثال:

""

​
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.

مثال:

false

الاستجابة

200 - application/json

Updated API key record.

​
success
boolean
مطلوب
​
message
string
مطلوب
​
data
object
مطلوب