> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# API 키 생성
> 인증된 계정에 대한 API 키를 생성하려면 CometAPI POST /api/token/을 사용하세요.
이 엔드포인트를 사용해 자동화, 내부 대시보드 또는 서버 측 통합을 위한 API 키를 생성할 수 있습니다.
[Console → Personal Settings](https://www.cometapi.com/console/personal)에서 personal access token을 생성한 다음, 이를 원시 `Authorization` header 값으로 전송하세요. `Bearer` 접두사는 붙이지 마세요.
생성 응답은 성공 여부만 확인해 줍니다. 새 키 레코드나 키 값은 포함되지 않습니다. 생성 후에는 [API 키 목록 조회](./list-api-keys)를 호출해 가장 최신 키 레코드를 읽으세요.
## 요청 본문
| Field | Type | Description |
| ---------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | 키의 사용자 식별용 표시 이름입니다. 50자 이하여야 합니다. |
| `expired_time` | integer | 키가 만료되는 시점의 Unix timestamp(초)입니다. 만료 없음은 `-1`을 사용하세요. |
| `remain_quota` | integer | CometAPI 내부 quota 단위의 시작 quota입니다. 이 값이 `0`에 도달하고 `unlimited_quota`가 `false`이면, 이 키를 사용하는 model 요청은 quota 소진으로 거부됩니다. |
| `unlimited_quota` | boolean | 이 키가 남은 quota 검사 없이 동작할지 여부입니다. `remain_quota`가 `0`이어도 키가 계속 동작해야 하는 경우에만 `true`로 설정하세요. |
| `model_limits_enabled` | boolean | 이 키를 특정 model로 제한할지 여부입니다. `false`이면 `model_limits`는 무시됩니다. |
| `model_limits` | string | `model_limits_enabled`가 `true`일 때 이 키에서 허용되는 model ID를 쉼표로 구분한 문자열입니다. `/v1/models`에서 반환된 model ID를 사용하세요. model 제한이 없으면 빈 문자열을 사용하세요. |
| `allow_ips` | string or null | 선택적 IP 허용 목록입니다. 항목 사이를 개행 문자(`\n`)로 구분한 하나의 JSON 문자열을 제공하세요. 각 항목은 단일 IPv4 주소, 단일 IPv6 주소, IPv4 CIDR 또는 IPv6 CIDR일 수 있습니다. IP 제한을 비활성화하려면 `null` 또는 `""`를 사용하세요. |
| `group` | string | 선택적 account group 제한입니다. 명시적인 group이 없으면 빈 문자열을 사용하세요. 비어 있지 않은 값은 해당 account에서 사용 가능해야 하며, 그렇지 않으면 API는 `success: false`를 반환합니다. |
| `cross_group_retry` | boolean | 자동 group 라우팅을 위한 cross-group retry 활성화 여부입니다. 이는 키가 auto-routed group을 사용할 때만 의미가 있습니다. |
## 허용 목록 형식
여러 IP 또는 CIDR 범위를 허용하려면, 항목 사이에 `\n`을 넣은 하나의 JSON 문자열로 전송하세요:
```json theme={null}
{
"allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
```
이 예시는 IPv4 주소 1개, IPv4 CIDR 범위 1개, IPv6 CIDR 범위 1개를 허용합니다.
## OpenAPI
````yaml api/openapi/api-keys/create-api-key.openapi.json POST /api/token/
openapi: 3.1.0
info:
title: Create API Key
version: 1.0.0
servers:
- url: https://api.cometapi.com
security:
- accessTokenAuth: []
paths:
/api/token/:
post:
summary: Create a new API key
description: >-
Create an API key for the authenticated account. The response confirms
success but does not include the new key record or key value; call the
list endpoint after creation to read the record.
operationId: createApiKey
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApiKeyRequest'
examples:
default:
summary: Create an API key
value:
name: production
expired_time: -1
remain_quota: 100000
unlimited_quota: false
model_limits_enabled: false
model_limits: ''
allow_ips: null
group: ''
cross_group_retry: false
with_ip_allowlist:
summary: Configure an IP allowlist
description: >-
Use one JSON string and separate multiple IP or CIDR entries
with `\n`.
value:
name: production
expired_time: -1
remain_quota: 100000
unlimited_quota: false
model_limits_enabled: false
model_limits: ''
allow_ips: |-
198.51.100.10
203.0.113.0/24
2001:db8::/32
group: ''
cross_group_retry: false
responses:
'200':
description: Create result.
content:
application/json:
schema:
$ref: '#/components/schemas/ResultEnvelope'
examples:
success:
summary: Created
value:
success: true
message: ''
name_too_long:
summary: Name too long
value:
success: false
message: token name is too long
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl https://api.cometapi.com/api/token/ \
-H "Authorization: your-access-token" \
-H "Content-Type: application/json" \
-d '{
"name": "production",
"expired_time": -1,
"remain_quota": 100000,
"unlimited_quota": false,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": null,
"group": "",
"cross_group_retry": false
}'
- lang: curl
label: cURL with IP allowlist
source: |-
curl https://api.cometapi.com/api/token/ \
-H "Authorization: your-access-token" \
-H "Content-Type: application/json" \
-d '{
"name": "production",
"expired_time": -1,
"remain_quota": 100000,
"unlimited_quota": false,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32",
"group": "",
"cross_group_retry": false
}'
components:
schemas:
CreateApiKeyRequest:
type: object
properties:
name:
type: string
maxLength: 50
description: >-
User-readable display name for the API key. The backend accepts up
to 50 Unicode characters; longer names return `success: false` with
`token name is too long`.
example: production
expired_time:
type: integer
description: >-
Unix timestamp in seconds when the key expires. Use `-1` for no
expiration. A past timestamp blocks model requests with this key.
example: -1
remain_quota:
type: integer
description: >-
Starting quota for the new key in CometAPI internal quota units. If
this reaches `0` while `unlimited_quota` is `false`, model requests
with this key are rejected as quota exhausted.
example: 100000
unlimited_quota:
type: boolean
description: >-
Whether the key bypasses remaining-quota checks. Set `true` only
when the key should keep working even if `remain_quota` is `0`.
example: false
model_limits_enabled:
type: boolean
description: >-
Whether to restrict this key to specific models. When `true`, only
model IDs listed in `model_limits` are allowed. When `false`,
`model_limits` is ignored.
example: false
model_limits:
type: string
description: >-
Comma-separated model IDs allowed by this key when
`model_limits_enabled` is `true`. Use model IDs returned by
`/v1/models`, for example `,`. Use an empty
string for no model restriction.
example: ''
allow_ips:
type:
- string
- 'null'
description: >-
Optional IP allowlist. Provide one JSON string with entries
separated by newline characters (`\n`). Each entry can be a single
IPv4 address, single IPv6 address, IPv4 CIDR, or IPv6 CIDR. Example
for three allowlist entries:
`198.51.100.10\n203.0.113.0/24\n2001:db8::/32`. CometAPI compares
the model request client IP to this list. Use `null` or `""` to
disable IP restrictions.
example: |-
198.51.100.10
203.0.113.0/24
2001:db8::/32
group:
type: string
description: >-
Optional account group restriction. Use an empty string for no
explicit group restriction. Non-empty values must be available to
the account, or the API returns `success: false` with a `no access
to group` message.
example: ''
cross_group_retry:
type: boolean
description: >-
Whether cross-group retry is enabled for automatic group routing.
This is only meaningful when the key uses an auto-routed group such
as `auto`.
example: false
additionalProperties: false
ResultEnvelope:
type: object
required:
- success
- message
properties:
success:
type: boolean
description: Whether the create operation succeeded.
example: true
message:
type: string
description: >-
Backend status message. The value is usually an empty string on
success.
example: ''
securitySchemes:
accessTokenAuth:
type: apiKey
in: header
name: Authorization
description: >-
Personal access token copied from CometAPI Console > Personal Settings.
Send the raw token value; do not prefix it with `Bearer`.
````