Получить API-ключ
Чтение метаданных собственного обычного ключа модели
Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.
Аутентификация, пагинация и ошибки описаны в разделе Подключение.
Поведение
Возвращает метаданные указанного ключа — имя, статус, квоту, срок действия и ограничения моделей. Мягко удалённые ключи читаются со статусом status=deleted. Полный секрет возвращается только ответами создания и ротации. Поле key здесь не возвращается.
Чужие или несуществующие ключи возвращают 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://api.toapis.com/api/v1/api-keys/42' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'import requests
response = requests.get(
"https://api.toapis.com/api/v1/api-keys/42",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.toapis.com/api/v1/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.idstringID ключа модели, не секретный ключ. Возвращается как десятичная строка 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 без ограничения. Десятичная строка для сохранения точности.
data.model_limitsstring[]Список разрешенных моделей как массив строк. Без ограничений возвращается [], никогда null.
data.allow_ipsstring[]Эффективный список IP этого ключа как массив строк в лексикографическом порядке; [] означает отсутствие ограничений. Другие ключи аккаунта и системный токен не затрагиваются. Несовпадающий IP при вызове модели дает 403. Изменения следуют существующему поведению кеша и выполняемых запросов.
Примеры ответов
Пример ответа
{
"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,
"model_limits": [],
"allow_ips": []
}
}