الانتقال إلى المحتوى الرئيسي

​
نظرة عامة

استخدم هذا الـ endpoint لتحديث الاسم أو حد الاستخدام أو النماذج المسموح بها أو وقت الانتهاء أو الحالة الخاصة بمفتاح API موجود.

​
جسم الطلب

يجب أن يتضمن طلب PATCH حقلًا واحدًا على الأقل.
الحقلالنوعالقيم الافتراضية / القيودالوصف
statusenum-active, inactive, revoked
namestringالطول 1-50اسم العرض بعد التحديث
limitAmountnumber | nullالحد الأدنى 0، الحد الأقصى للإدخال 1000000null = غير محدود، 0 = حصة صفرية. تُطبّع القيم الموجبة إلى حد مخزن لا يمكن أن يتجاوز ما يعادل 100000 دولارًا أمريكيًا.
limitCurrencyتعدادافتراضي USDUSD فقط. إرسال CNY يُرجع 400 currency_retired.
modelsstring[]-قائمة النماذج المنطقية المسموح بها بعد التحديث
expiresAtstring | nullتاريخ ووقت RFC3339null يزيل وقت الانتهاء

​
ملاحظات

  • لا يدعم Management API v1 الحذف النهائي عمدًا.
  • تُعامل الحالة revoked عادةً كحالة نهائية للاستخدام التشغيلي العادي؛ وإذا احتجت إلى مفتاح جديد، فأنشئ مفتاحًا جديدًا بدلًا من توقع وجود مسار لاحق لفك الإلغاء.

​
مثال

curl -X PATCH "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "limitAmount": 0
  }'

​
الطلب / الاستجابة

استخدم لوحة OpenAPI التفاعلية أعلاه للاطلاع على المخطط الدقيق وحقول الاستجابة.

​
Response example

{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key_prefix": "sk-live...",
  "status": "inactive",
  "limit_amount": 0,
  "limit_amount_decimal": "0",
  "used_amount": 148.25,
  "used_amount_decimal": "148.25",
  "models": [
    "gpt-5-mini",
    "claude-3-7-sonnet"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": "2026-07-08T03:12:45.000Z",
  "created_at": "2026-07-01T10:00:00.000Z"
}

​
Important fields

​
id
string
API key identifier used in follow-up Management API calls.
​
name
string
Display name for the API key.
​
key_prefix
string
Non-secret key prefix for display and support.
​
status
string
One of active, inactive, or revoked.
​
limit_amount
number | null
Spending cap in USD as a JSON number for display. null means unlimited.
​
limit_amount_decimal
string | null
Exact spending cap in USD as a decimal string. null means unlimited.
​
used_amount
number
Accumulated usage in USD as a JSON number for display.
​
used_amount_decimal
string
Exact accumulated usage in USD as a decimal string.
​
models
string[]
Per-key model allowlist. Empty array means no additional key-level model restriction.
​
expires_at
string | null
ISO timestamp when the key expires, or null for no expiry.
​
last_used_at
string | null
ISO timestamp for the most recent use, or null when unused.
​
created_at
string
ISO creation timestamp.