نظرة عامة
ينشئ هذا الـ endpoint مفتاح API جديدًا من نوعtype=user داخل المؤسسة المرتبطة برمز الإدارة الحالي.
جسم الطلب
| الحقل | النوع | القيم الافتراضية / القيود | الوصف |
|---|---|---|---|
name | string | مطلوب، الافتراضي Default Key، الطول 1-50 | اسم العرض؛ تتم إزالة المسافات من البداية والنهاية على الخادم |
limitAmount | number | null | الحد الأدنى 0، الحد الأقصى للإدخال 1000000 | null أو الحذف = غير محدود، 0 = حصة صفرية. تُطبّع القيم الموجبة إلى حد مخزن لا يمكن أن يتجاوز ما يعادل 100000 دولارًا أمريكيًا. |
limitCurrency | تعداد | افتراضي USD | USD فقط. إرسال CNY يُرجع 400 currency_retired. |
models | string[] | الافتراضي [] | قائمة اختيارية للنماذج المنطقية المسموح بها |
expiresAt | string | null | تاريخ ووقت RFC3339 | null يعني عدم وجود انتهاء |
ملاحظات
- تظهر القيمة الكاملة لمفتاح API مرة واحدة فقط في الاستجابة.
- تعني
models: []أن المفتاح لا يفرض قيودًا إضافية على النماذج خارج سياسة المؤسسة. - تؤدي
limitAmount: 0إلى إنشاء مفتاح صالح لكن من دون حصة قابلة للاستخدام إلى أن يتم تحديثه لاحقًا.
مثال
الطلب / الاستجابة
استخدم لوحة OpenAPI التفاعلية أعلاه للاطلاع على المخطط الدقيق وحقول الاستجابة.Response example
Important fields
Full secret API key value. It is returned only once on creation.
API key identifier used in follow-up Management API calls.
Display name for the API key.
Non-secret key prefix for display and support.
One of
active, inactive, or revoked.Spending cap in USD as a JSON number for display.
null means unlimited.Exact spending cap in USD as a decimal string.
null means unlimited.Accumulated usage in USD as a JSON number for display.
Exact accumulated usage in USD as a decimal string.
Per-key model allowlist. Empty array means no additional key-level model restriction.
ISO timestamp when the key expires, or
null for no expiry.ISO timestamp for the most recent use, or
null when unused.ISO creation timestamp.