Skip to main content
GET
  • Запрос потребления токенов и стоимости по каждому запросу для всех ваших API-ключей, либо фильтрация по одному ключу
  • Входные, выходные и кешированные токены учитываются отдельно
  • Сводный эндпоинт агрегирует итоги по каждому ключу
  • Пагинация по курсору, окно времени до 31 дня
Эти эндпоинты читают биллинговые логи и возвращают каждый оплаченный запрос с разбивкой по токенам и стоимостью, а также сводку по ключам. Они дополняют эндпоинт запроса баланса токена, который возвращает только суммарный баланс одного ключа.

Авторизация

string
обязательно
Эти эндпоинты аутентифицируются как учётная запись пользователя, а не как API-ключ.
  1. Откройте страницу настроек аккаунта и нажмите Сгенерировать токен в карточке «Системный токен доступа», чтобы получить токен доступа (это не sk- ключ). Повторная генерация аннулирует предыдущий токен.
  2. Передавайте его в заголовке Authorization вместе с вашим ID пользователя:
Числовой ID пользователя показан на той же странице настроек.
string
обязательно
Ваш числовой ID пользователя. Обязателен вместе с токеном доступа.

Эндпоинты

Параметры запроса

Оба эндпоинта принимают одинаковые параметры. Неизвестные или повторяющиеся параметры отклоняются с кодом 422.
integer
обязательно
Начало окна времени, Unix-метка в секундах (включительно).
integer
обязательно
Конец окна времени, Unix-метка в секундах (не включительно). Должна быть позже start_timestamp; окно не более 31 дня.
integer
Необязательно. Ограничивает результат одним API-ключом по его числовому ID. Без параметра включаются все ключи.
integer
по умолчанию:"50"
Число строк на странице, 1–100.
string
Курсор пагинации из meta.next_cursor предыдущего ответа. Действителен только для того же эндпоинта, окна времени и фильтра token_id, которые его создали.

Ответ

GET /api/usage/tokens/requests возвращает по одной строке на каждый оплаченный запрос, от новых к старым.
integer
Внутренний ID лога запроса. Уникален в пределах ответа.
integer
Время списания за запрос, Unix-метка в секундах.
integer
ID API-ключа, выполнившего запрос.
string
Имя API-ключа.
string
Модель, обработавшая запрос.
string
ID задачи для асинхронных запросов (генерация изображений/видео). Пусто для синхронных запросов.
integer
Оплаченные входные токены.
integer
Оплаченные выходные токены.
integer | null
Входные токены, прочитанные из кеша (попадания в кеш). null, если апстрим не сообщил данные о кеше.
integer | null
Токены, записанные в кеш. null, если не сообщались.
integer | null
Общее число токенов по данным апстрим-провайдера, если доступно.
integer
prompt_tokens + completion_tokens.
string
pre_consumed, settled или unknown для логов без подробных биллинговых метаданных.
integer
Потреблённая квота во внутренних единицах платформы.
string
Стоимость в USD, рассчитанная как quota / quota_per_usd (см. meta). Возвращается строкой для сохранения точности.
GET /api/usage/tokens/summary возвращает по одной строке на каждый API-ключ, упорядоченные по token_id.
integer
ID API-ключа.
integer
Число оплаченных запросов в окне.
integer
Сумма входных токенов этого ключа.
integer
Сумма выходных токенов этого ключа.
integer
prompt_tokens + completion_tokens.
integer
Суммарная потреблённая квота этого ключа.
string
Суммарная стоимость этого ключа в USD.

Meta

boolean
Есть ли следующая страница.
string
Передайте как cursor, чтобы получить следующую страницу. Пусто, когда has_more равно false.
string
Число внутренних единиц квоты на 1 USD, использованное для пересчёта cost_usd.
boolean
Включено ли логирование потребления. При false ответы могут быть пустыми.
boolean
Сейчас всегда false — возвраты не вычитаются.

Примечания

  • В список попадают только оплаченные запросы. Не оплаченные неудачные запросы не отображаются, отдельного флага успеха по запросу нет.
  • Стоимость рассчитана по квоте, записанной при списании; по текущему каталогу не пересчитывается, возвраты не вычитаются.
  • Эти эндпоинты не раскрывают сами API-ключи, каналы, IP-адреса и содержимое запросов/ответов.
  • cursor привязан к эндпоинту, окну времени и фильтру token_id — не используйте его в других запросах.
  • У запросов короткий таймаут; при получении query_timeout сократите окно времени и повторите.