> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# إنشاء مفتاح API

> ينشئ مفتاح API جديدًا للمستخدم في المؤسسة الحالية.

## نظرة عامة

ينشئ هذا الـ 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` إلى إنشاء مفتاح صالح لكن من دون حصة قابلة للاستخدام إلى أن يتم تحديثه لاحقًا.

## مثال

<RequestExample>
  ```bash cURL theme={null}
  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"
    }'
  ```
</RequestExample>

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

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

## Response example

<ResponseExample>
  ```json 201 Created theme={null}
  {
    "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"
  }
  ```
</ResponseExample>

## Important fields

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