Atualizar uma chave de API - CometAPI Documentation

PUT

api

token

curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "group": "",
    "cross_group_retry": false
  }'

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Use este endpoint para atualizar o nome, status, quota, expiração, restrições de modelo, lista de permissões de IP e configurações de grupo de uma chave de API.

Gere um personal access token em Console → Personal Settings e, em seguida, envie-o como o valor bruto do cabeçalho Authorization. Não adicione o prefixo Bearer.

Este endpoint usa PUT /api/token/, e o id deve estar no corpo JSON. Envie os campos editáveis que deseja preservar; campos numéricos, booleanos ou de string omitidos podem ser redefinidos pela atualização.

Corpo da solicitação

Field	Type	Description
`id`	integer	Obrigatório. ID da chave de API retornado por List API keys.
`name`	string	Nome de exibição legível pelo usuário para a chave. Deve ter 50 caracteres ou menos.
`status`	integer	Status operacional. `1` habilita a chave para solicitações de modelo. `2` a desabilita. `3` a marca como expirada. `4` a marca como quota esgotada. Chaves desabilitadas, expiradas ou esgotadas são rejeitadas pelos endpoints de modelo.
`expired_time`	integer	Timestamp Unix em segundos quando a chave expira. Use `-1` para sem expiração. Um timestamp no passado bloqueia solicitações de modelo.
`remain_quota`	integer	Quota restante nas unidades internas de quota da CometAPI. Se isso chegar a `0` e `unlimited_quota` for `false`, as solicitações de modelo com esta chave serão rejeitadas como quota esgotada.
`unlimited_quota`	boolean	Se a chave ignora as verificações de quota restante. Defina `true` somente quando a chave deve continuar funcionando mesmo se `remain_quota` for `0`.
`model_limits_enabled`	boolean	Se esta chave deve ser restrita a modelos específicos. Quando `false`, `model_limits` é ignorado.
`model_limits`	string	model IDs separados por vírgula permitidos por esta chave quando `model_limits_enabled` for `true`. Use os model IDs retornados por `/v1/models`; use uma string vazia para nenhuma restrição de modelo.
`allow_ips`	string or null	Lista de permissões de IP opcional. Forneça uma única string JSON com entradas separadas por caracteres de nova linha (`\n`). Cada entrada pode ser um único endereço IPv4, um único endereço IPv6, um CIDR IPv4 ou um CIDR IPv6. Use `null` ou `""` para desabilitar restrições de IP.
`group`	string	Restrição opcional de grupo da conta. Use uma string vazia para nenhum grupo explícito. Valores não vazios devem estar disponíveis para a conta, caso contrário a API retorna `success: false`.
`cross_group_retry`	boolean	Se a nova tentativa entre grupos está habilitada para roteamento automático de grupos. Isso só faz sentido quando a chave usa um grupo com roteamento automático.

Formato da lista de permissões

Para permitir vários IPs ou intervalos CIDR, envie-os como uma única string JSON com \n entre as entradas:

{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}

Este exemplo permite um endereço IPv4, um intervalo CIDR IPv4 e um intervalo CIDR IPv6.

Autorizações

Authorization

string

header

obrigatório

Personal access token copied from CometAPI Console > Personal Settings. Send the raw token value; do not prefix it with Bearer.

Corpo

application/json

integer

obrigatório

Numeric API key ID returned by the list endpoint. For updates, send this value in the JSON body, not in the URL.

Exemplo:

1234

name

string

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.

Maximum string length: 50

Exemplo:

"production"

status

enum<integer>

Operational status for the key. 1 enables the key for model requests, 2 disables it, 3 marks it expired, and 4 marks it quota exhausted. Disabled, expired, or exhausted keys are rejected by model endpoints.

Opções disponíveis:

1,

2,

3,

4

Exemplo:

1

expired_time

integer

Unix timestamp in seconds when the key expires. Use -1 for no expiration. A past timestamp blocks model requests with this key.

Exemplo:

-1

remain_quota

integer

Remaining quota to assign to the 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.

Exemplo:

100000

unlimited_quota

boolean

Whether the key bypasses remaining-quota checks. Set true only when the key should keep working even if remain_quota is 0.

Exemplo:

false

model_limits_enabled

boolean

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.

Exemplo:

false

model_limits

string

Comma-separated model IDs allowed by this key when model_limits_enabled is true. Use model IDs returned by /v1/models, for example <model-id-1>,<model-id-2>. Use an empty string for no model restriction.

Exemplo:

""

allow_ips

string | null

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.

Exemplo:

"198.51.100.10\n203.0.113.0/24\n2001:db8::/32"

group

string

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.

Exemplo:

""

cross_group_retry

boolean

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.

Exemplo:

false

Resposta

200 - application/json

Updated API key record.

success

boolean

obrigatório

message

string

obrigatório

data

object

obrigatório

Show child attributes

Excluir uma chave de API

curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "group": "",
    "cross_group_retry": false
  }'

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Documentation Index

​Corpo da solicitação

​Formato da lista de permissões

Autorizações

Corpo

Resposta

Corpo da solicitação

Formato da lista de permissões