Обзор API платформы
API платформы позволяет скриптам и сторонним системам управлять вашим аккаунтом RouteAPI от вашего имени: запрашивать баланс, создавать API Key и управлять ими, а также просматривать логи аккаунта (с экспортом в CSV/JSONL) и статистику использования.
Base URL: https://www.routeapi.ai/api/open/v1
Аутентификация: Authorization: Bearer rat_xxxx — о создании и хранении ключа управления см. Аутентификация в API платформы.
Пример запроса
Section titled “Пример запроса”curl https://www.routeapi.ai/api/open/v1/balance \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"Все эндпоинты под /api/open/v1 принимают один и тот же заголовок. Ответы используют единое тело { success, message, data }; его формат, коды ошибок и ограничения частоты см. в разделе Ошибки и лимиты.
Суммы и валюта
Section titled “Суммы и валюта”Все денежные поля указаны в валюте отображения сайта с двумя знаками после запятой (например, 10.00); валюта возвращается эндпоинтом Получить баланс. Каждая сумма округляется отдельно, поэтому итоговая сумма может отличаться от суммы значений построчно на величину до 0,01.
Пагинация
Section titled “Пагинация”Эндпоинты списков используют одну и ту же постраничную пагинацию:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
p | integer | 1 | Номер страницы, от 1 до 1000000 |
page_size | integer | 10 | Элементов на странице, от 1 до 1000 |
Явно переданные p или page_size должны попадать в эти диапазоны. Нецелые значения, 0, отрицательные и значения вне диапазона возвращают 400 invalid_request; они не заменяются и не ограничиваются молча. Поля page / page_size в ответе — фактически применённые значения.
Для эндпоинтов логов total подсчитывается максимум до 10000 и всегда равен 10000 при большем числе совпадений; для получения более старых данных используйте более короткие временные окна.
Кодирование query string
Section titled “Кодирование query string”Не передавайте необработанный ; в query string; кодируйте его как %3B, иначе весь запрос вернёт 400 invalid_request. Кодируйте % как %25, а пробелы — как + или %20.
Эндпоинты
Section titled “Эндпоинты”Пути ниже указаны относительно https://www.routeapi.ai/api/open/v1.
Аккаунт
Section titled “Аккаунт”| Метод | Путь | Описание |
|---|---|---|
| GET | /balance | Получить баланс |
API Keys
Section titled “API Keys”| Метод | Путь | Описание |
|---|---|---|
| GET | /keys | Список API Key |
| GET | /keys/:id | Получить API Key |
| GET | /keys/:id/key | Получить полный API Key |
| POST | /keys | Создать API Key |
| PATCH | /keys/:id | Изменить API Key |
| DELETE | /keys/:id | Удалить API Key |
| Метод | Путь | Описание |
|---|---|---|
| GET | /logs | Получить логи аккаунта |
| GET | /logs/export | Экспорт логов |
Использование
Section titled “Использование”| Метод | Путь | Описание |
|---|---|---|
| GET | /usage | Получить статистику использования |
| GET | /usage/models | Получить использование по моделям |
| GET | /usage/keys | Получить использование по Key |