> ## 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 Key

> 為目前組織建立新的使用者 API Key。

## 概覽

這個 endpoint 會在目前管理令牌所屬的組織下，建立一把新的 `type=user` API Key。

## 請求主體

| 欄位              | 型別             | 預設值 / 限制                      | 說明                                                              |
| --------------- | -------------- | ----------------------------- | --------------------------------------------------------------- |
| `name`          | string         | 必填，預設 `Default Key`，長度 `1-50` | 顯示名稱，伺服器端會先去除前後空白                                               |
| `limitAmount`   | number \| null | 最小 `0`，輸入上限 `1000000`         | `null` 或省略 = 不限額，`0` = 零額度，正數會被規範化為一個儲存上限，且不能超過 `100000` USD 等值 |
| `limitCurrency` | 列舉             | 預設 `USD`                      | 僅限 USD。傳送 `CNY` 會回傳 `400 currency_retired`。                     |
| `models`        | string\[]      | 預設 `[]`                       | 可選的模型白名單                                                        |
| `expiresAt`     | string \| null | RFC3339 datetime              | `null` 表示沒有到期時間                                                 |

## 說明

* 回應中的完整 API Key 只會顯示一次。
* `models: []` 表示這把 Key 除了組織層政策外，沒有額外的模型限制。
* `limitAmount: 0` 會建立一把有效、但暫時無法消耗額度的 Key，之後可再更新。

## 範例

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

## 請求 / 回應

精確 schema 與回應欄位，請使用上方的互動式 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>
