> ## 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.
# Einen API-Schlüssel erstellen
> Verwenden Sie CometAPI POST /api/token/, um einen API-Schlüssel für das authentifizierte Konto zu erstellen.
Verwenden Sie diesen Endpoint, um einen API-Schlüssel für Automatisierung, interne Dashboards oder serverseitige Integrationen zu erstellen.
Generieren Sie ein personal access token unter [Console → Personal Settings](https://www.cometapi.com/console/personal) und senden Sie es dann als rohen `Authorization`-Header-Wert. Stellen Sie ihm nicht `Bearer` voran.
Die Erstellungsantwort bestätigt nur den Erfolg. Sie enthält weder den neuen Schlüsseleintrag noch den Schlüsselwert. Rufen Sie nach der Erstellung [API-Schlüssel auflisten](./list-api-keys) auf, um den neuesten Schlüsseleintrag zu lesen.
## Request body
| Field | Type | Description |
| ---------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Für Nutzer lesbarer Anzeigename für den Schlüssel. Darf höchstens 50 Zeichen lang sein. |
| `expired_time` | integer | Unix-Zeitstempel in Sekunden, wann der Schlüssel abläuft. Verwenden Sie `-1` für kein Ablaufdatum. |
| `remain_quota` | integer | Anfangsquota in internen Quota-Einheiten von CometAPI. Wenn dieser Wert `0` erreicht und `unlimited_quota` `false` ist, werden model-Anfragen mit diesem Schlüssel wegen ausgeschöpfter Quota abgelehnt. |
| `unlimited_quota` | boolean | Gibt an, ob der Schlüssel Prüfungen der verbleibenden Quota umgeht. Setzen Sie `true` nur, wenn der Schlüssel weiter funktionieren soll, auch wenn `remain_quota` `0` ist. |
| `model_limits_enabled` | boolean | Gibt an, ob dieser Schlüssel auf bestimmte Modelle beschränkt werden soll. Wenn `false`, wird `model_limits` ignoriert. |
| `model_limits` | string | Durch Kommas getrennte model IDs, die für diesen Schlüssel erlaubt sind, wenn `model_limits_enabled` `true` ist. Verwenden Sie die von `/v1/models` zurückgegebenen model IDs; verwenden Sie einen leeren String für keine Modellbeschränkung. |
| `allow_ips` | string or null | Optionale IP-Allowlist. Geben Sie einen JSON-String mit durch Zeilenumbruchzeichen (`\n`) getrennten Einträgen an. Jeder Eintrag kann eine einzelne IPv4-Adresse, eine einzelne IPv6-Adresse, ein IPv4-CIDR oder ein IPv6-CIDR sein. Verwenden Sie `null` oder `""`, um IP-Beschränkungen zu deaktivieren. |
| `group` | string | Optionale Kontogruppenbeschränkung. Verwenden Sie einen leeren String, wenn keine explizite Gruppe gesetzt werden soll. Nicht leere Werte müssen für das Konto verfügbar sein, andernfalls gibt die API `success: false` zurück. |
| `cross_group_retry` | boolean | Gibt an, ob gruppenübergreifender Retry für automatisches Gruppenrouting aktiviert ist. Das ist nur relevant, wenn der Schlüssel eine automatisch geroutete Gruppe verwendet. |
## Allowlist-Format
Um mehrere IPs oder CIDR-Bereiche zu erlauben, senden Sie sie als einen JSON-String mit `\n` zwischen den Einträgen:
```json theme={null}
{
"allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
```
Dieses Beispiel erlaubt eine IPv4-Adresse, einen IPv4-CIDR-Bereich und einen IPv6-CIDR-Bereich.
## 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`.
````