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

نظرة عامة

ينشئ هذا الـ endpoint مفتاح API جديدًا من نوع type=user داخل المؤسسة المرتبطة برمز الإدارة الحالي.

جسم الطلب

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

ملاحظات

  • تظهر القيمة الكاملة لمفتاح API مرة واحدة فقط في الاستجابة.
  • تعني models: [] أن المفتاح لا يفرض قيودًا إضافية على النماذج خارج سياسة المؤسسة.
  • تؤدي limitAmount: 0 إلى إنشاء مفتاح صالح لكن من دون حصة قابلة للاستخدام إلى أن يتم تحديثه لاحقًا.

مثال

curl -X POST "https://api.tokenlab.sh/v1/management/api-keys" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Backend Worker",
    "limitAmount": 500,
    "models": ["veo3.1", "kling-3.0-video"],
    "expiresAt": "2026-12-31T23:59:59Z"
  }'

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

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

Response example

{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key": "sk-live-redacted",
  "key_prefix": "sk-live...",
  "status": "active",
  "limit_amount": 500,
  "limit_amount_decimal": "500",
  "used_amount": 0,
  "used_amount_decimal": "0",
  "models": [
    "veo3.1",
    "kling-3.0-video"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": null,
  "created_at": "2026-07-08T03:00:00.000Z"
}

Important fields

key
string
Full secret API key value. It is returned only once on creation.
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.