Skip to content

Список API Key

GET /api/open/v1/keys
ПараметрГдеТипОбязательныйПо умолчаниюОписание
pqueryintegerНет1Номер страницы, от 1 до 1000000
page_sizequeryintegerНет10Элементов на странице, от 1 до 1000
namequerystringНет—Фильтр по точному имени Key; для нескольких значений повторяйте параметр (?name=a&name=b). Запятые не поддерживаются, так как имена могут их содержать

Явно переданные неверные p / page_size возвращают 400; см. Пагинация.

Каждый параметр с несколькими значениями принимает не более 50 значений; при превышении возвращается 400 invalid_request. Если указан name, поле total отражает отфильтрованный результат.

Terminal window
curl "https://www.routeapi.ai/api/open/v1/keys?p=1&page_size=20&name=bot" \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"
{
"success": true,
"message": "",
"data": {
"items": [
{
"id": 12,
"name": "bot",
"key": "sk-abcd**********wxyz",
"status": 1,
"created_time": 1729000000,
"accessed_time": 1729000000,
"expired_time": -1,
"remain_amount": 10.00,
"unlimited": false,
"used_amount": 0.00,
"model_limits_enabled": true,
"model_limits": "gpt-4o,gpt-4o-mini",
"allow_ips": ""
}
],
"total": 1,
"page": 1,
"page_size": 20
}
}
ПолеТипОписание
itemsarrayОбъекты Key, отсортированные по ID по убыванию (сначала новые)
totalintegerОбщее количество Key, соответствующих фильтрам
pageintegerТекущий номер страницы
page_sizeintegerФактическое количество элементов на странице

Все эндпоинты API платформы, возвращающие Key, используют одну и ту же структуру:

ПолеТипОписание
idintegerID Key, используется как :id в других эндпоинтах
namestringИмя
keystringЗначение Key с префиксом sk-; маскируется везде, кроме эндпоинта создания и Получить полный API Key
statusinteger1 включён, 2 отключён (остановлен вручную; можно снова включить), 3 истёк, 4 исчерпан; включайте и отключайте через эндпоинт обновления (только 1 / 2)
created_timeintegerВремя создания, unix-секунды
accessed_timeintegerВремя последнего использования, unix-секунды
expired_timeintegerСрок действия, unix-секунды; -1 означает бессрочно
remain_amountnumberОставшаяся доступная сумма, два знака после запятой; не имеет смысла, когда unlimited равно true
unlimitedbooleanБезлимитный ли Key
used_amountnumberИзрасходованная сумма, два знака после запятой
model_limits_enabledbooleanВключён ли белый список моделей
model_limitsstringРазрешённые модели через запятую
allow_ipsstringРазрешённые IP, по одному на строку; пустая строка означает отсутствие ограничений