获取一个 API key - CometAPI Documentation

GET

api

token

{id}

cURL

curl https://api.cometapi.com/api/token/1234 \
  -H "Authorization: your-access-token"

import requests

url = "https://api.cometapi.com/api/token/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.cometapi.com/api/token/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cometapi.com/api/token/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cometapi.com/api/token/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cometapi.com/api/token/{id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cometapi.com/api/token/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "$COMETAPI_KEY",
    "status": 1,
    "name": "production",
    "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
  }
}

使用此端点按 ID 获取一条 API key 记录。

在 Console → Personal Settings 生成个人访问令牌，然后将其作为原始 Authorization 请求头值发送。不要添加 Bearer 前缀。

路径参数 id 是由列出 API keys返回的数字 key ID。

API key 状态

Status	Meaning
`1`	已启用
`2`	已禁用
`3`	已过期
`4`	已耗尽

返回字段

Field	Type	Description
`id`	integer	数字 API key ID。将此值与更新一个 API key和删除一个 API key一起使用。
`key`	string	由管理 API 返回的 API key 值。请将其视为机密，并在模型请求中将其用作 `Authorization: Bearer $COMETAPI_KEY`。
`status`	integer	运行状态。只有 `1` 表示该 key 已启用，可用于模型请求。
`name`	string	便于用户识别的 key 显示名称。
`created_time`	integer	该 key 创建时的 Unix 时间戳（秒）。
`accessed_time`	integer	该 key 上次使用时的 Unix 时间戳（秒）。
`expired_time`	integer	该 key 过期时的 Unix 时间戳（秒）。`-1` 表示永不过期。
`remain_quota`	integer	以 CometAPI 内部配额单位表示的剩余额度。
`used_quota`	integer	该 key 已消耗的额度，以 CometAPI 内部配额单位表示。
`unlimited_quota`	boolean	该 key 是否跳过剩余额度检查。
`model_limits_enabled`	boolean	是否对此 key 启用模型限制。
`model_limits`	string	当 `model_limits_enabled` 为 `true` 时，此 key 允许使用的以逗号分隔的 model ID。空值表示未配置模型列表。
`allow_ips`	string or null	IP 允许列表，表示为一个按换行分隔的字符串。每一项可以是单个 IPv4 地址、单个 IPv6 地址、IPv4 CIDR 或 IPv6 CIDR。`null` 或 `""` 表示没有 IP 限制。
`group`	string	账户分组限制。空值表示没有显式的分组限制。
`cross_group_retry`	boolean	是否为自动分组路由启用跨组重试。

授权

Authorization

string

header

必填

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

路径参数

integer

必填

Numeric API key ID returned by the list endpoint.

响应

200 - application/json

API key record.

success

boolean

必填

message

string

必填

data

object

必填

Show child attributes

创建 API key

删除一个 API 密钥

cURL

curl https://api.cometapi.com/api/token/1234 \
  -H "Authorization: your-access-token"

import requests

url = "https://api.cometapi.com/api/token/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.cometapi.com/api/token/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cometapi.com/api/token/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cometapi.com/api/token/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cometapi.com/api/token/{id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cometapi.com/api/token/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "$COMETAPI_KEY",
    "status": 1,
    "name": "production",
    "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
  }
}

​API key 状态

​返回字段

授权

路径参数

响应

API key 状态

返回字段