Получить API-ключ | ToAPIs Documentation

GET

/api/v1/account/api-keys/%7Bapi_key_id%7D

Для пользователей из материкового Китая: используйте https://toapis.cn в качестве эндпоинта (Base URL). Замените https://toapis.com на https://toapis.cn во всех примерах этого документа.

Аутентификация, пагинация и ошибки описаны в разделе Начало работы.

Поведение

Читаются только метаданные собственных обычных ключей моделей. Список сортируется по числовому ID убывающе и по умолчанию исключает мягко удаленные ключи и stats:read. Детали доступны и для своих удаленных ключей. key_hint содержит маску и последние 4 символа либо null для коротких ключей. Безлимит: unlimited=true, remaining_credits=null; отсутствие дневного/месячного лимита также равно null. Полный ключ и секрет Webhook не возвращаются. Чужой и отсутствующий ключ возвращают 404.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.

Параметры

api_key_idstringпутьобязательно

Десятичный строковый ID собственного ключа модели. Чужой ключ возвращает 404. Удаленный ключ позволяет фильтровать собственную историю.

Ограничения: pattern=^[1-9][0-9]*$.

Пример запроса

curl --request GET \
  --url 'https://toapis.com/api/v1/account/api-keys/42' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://toapis.com/api/v1/account/api-keys/42",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const url = new URL("https://toapis.com/api/v1/account/api-keys/42");

const response = await fetch(url, {
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Данные примеров вымышлены и предполагают credits_per_usd="100". Используйте коэффициент из ответа API.

codeinteger

Числовой код результата; 0 означает успех.

messagestring

Сообщение ответа; пустое при успехе. Сообщения об ошибках локализуются.

dataobject

Объект результата текущего запроса.

data.idstring

ID ключа модели, не секретный ключ. Возвращается как десятичная строка ID.

data.namestring

Имя API-ключа.

data.key_hintstring | null

Маска и последние 4 символа ключа. Полный секрет не возвращается; короткие ключи дают null.

data.statusstring

Текущий статус API-ключа. Детали доступны и для собственных мягко удаленных ключей. Значения: enabled, disabled, expired, exhausted, deleted, unknown.

data.created_atstring | null

Время создания. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.expires_atstring | null

Время истечения ключа; null, если срок не задан. Время в RFC 3339 с часовым поясом.

data.unlimitedboolean

Безлимитная ли квота ключа. При true поле remaining_credits=null.

data.remaining_creditsstring | null

Оставшиеся credits. Для безлимитного API-ключа равны null. Десятичная строка для сохранения точности.

data.daily_limit_creditsstring | null

Дневной лимит в credits; null без ограничения. Десятичная строка для сохранения точности.

data.monthly_limit_creditsstring | null

Месячный лимит в credits; null без ограничения. Десятичная строка для сохранения точности.

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "id": "42",
    "name": "Example Key",
    "key_hint": "****abcd",
    "status": "enabled",
    "created_at": "2026-10-01T00:00:00Z",
    "expires_at": null,
    "unlimited": false,
    "remaining_credits": "500",
    "daily_limit_credits": "100",
    "monthly_limit_credits": null
  }
}