История и расходы
MarkdownМетоды, поля запросов и ответы.
Полное руководство
В разделе 11 методов. Откройте метод, чтобы посмотреть условия доступа, поля запроса и ответ.
| Метод и путь | Описание | Доступ |
|---|---|---|
GET /api/v1/usage | История запросов | Токен кабинета |
GET /api/v1/usage/:id | Один запрос из истории | Токен кабинета |
POST /api/v1/usage/dashboard/api-keys-usage | Статистика собственных API-ключей | Токен кабинета |
GET /api/v1/usage/dashboard/models | Использование по моделям | Токен кабинета |
GET /api/v1/usage/dashboard/snapshot-v2 | Единый снимок графиков | Токен кабинета |
GET /api/v1/usage/dashboard/stats | Итоги использования | Токен кабинета |
GET /api/v1/usage/dashboard/trend | Динамика использования | Токен кабинета |
GET /api/v1/usage/errors | История ошибок | Токен кабинета |
GET /api/v1/usage/errors/:id | Подробности собственной ошибки | Токен кабинета |
GET /api/v1/usage/stats | Статистика использования | Токен кабинета |
GET /api/v1/user/api-keys/:id/usage/daily | Дневная статистика собственного API-ключа | Токен кабинета |
GET /api/v1/usage — История запросов
Доступ: Токен кабинета
/api/v1/usagecurl --fail-with-body "https://ailoot.ai/api/v1/usage" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
sort_by | string | нет | ; по умолчанию: created_at |
sort_order | string | нет | ; по умолчанию: desc |
api_key_id | integer | нет | |
request_type | string | нет | |
stream | boolean | нет | |
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
period | string | нет | |
model | string | нет | |
page | integer | нет | ; по умолчанию: 1; positive; page_size/limit <=1000 |
page_size | integer | нет | ; по умолчанию: 20; positive; page_size/limit <=1000 |
limit | integer | нет | ; по умолчанию: 20; positive; page_size/limit <=1000 |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: UsageLog. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"items": [
{
"id": "PLACEHOLDER_ID (integer)",
"user_id": "PLACEHOLDER_USER_ID (integer)",
"api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
"request_id": "PLACEHOLDER_REQUEST_ID (string)",
"model": "PLACEHOLDER_MODEL (string)",
"service_tier": "PLACEHOLDER_SERVICE_TIER (string)",
"reasoning_effort": "PLACEHOLDER_REASONING_EFFORT (string)",
"input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
"output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
"cache_creation_tokens": "PLACEHOLDER_CACHE_CREATION_TOKENS (integer)",
"cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
"cache_creation_5m_tokens": "PLACEHOLDER_CACHE_CREATION_5M_TOKENS (integer)",
"cache_creation_1h_tokens": "PLACEHOLDER_CACHE_CREATION_1H_TOKENS (integer)",
"input_cost": "PLACEHOLDER_INPUT_COST (number)",
"output_cost": "PLACEHOLDER_OUTPUT_COST (number)",
"cache_creation_cost": "PLACEHOLDER_CACHE_CREATION_COST (number)",
"cache_read_cost": "PLACEHOLDER_CACHE_READ_COST (number)",
"total_cost": "PLACEHOLDER_TOTAL_COST (number)",
"actual_cost": "PLACEHOLDER_ACTUAL_COST (number)",
"long_context_billing_applied": "PLACEHOLDER_LONG_CONTEXT_BILLING_APPLIED (boolean)",
"request_type": "PLACEHOLDER_REQUEST_TYPE (string)",
"stream": "PLACEHOLDER_STREAM (boolean)",
"duration_ms": "PLACEHOLDER_DURATION_MS (integer)",
"first_token_ms": "PLACEHOLDER_FIRST_TOKEN_MS (integer)",
"image_count": "PLACEHOLDER_IMAGE_COUNT (integer)",
"image_size": "PLACEHOLDER_IMAGE_SIZE (string)",
"image_input_size": "PLACEHOLDER_IMAGE_INPUT_SIZE (string)",
"image_output_size": "PLACEHOLDER_IMAGE_OUTPUT_SIZE (string)",
"image_input_tokens": "PLACEHOLDER_IMAGE_INPUT_TOKENS (integer)",
"image_input_cost": "PLACEHOLDER_IMAGE_INPUT_COST (number)",
"image_output_tokens": "PLACEHOLDER_IMAGE_OUTPUT_TOKENS (integer)",
"image_output_cost": "PLACEHOLDER_IMAGE_OUTPUT_COST (number)",
"image_size_breakdown": "PLACEHOLDER_IMAGE_SIZE_BREAKDOWN (object)",
"media_type": "PLACEHOLDER_MEDIA_TYPE (string)",
"ip_address": "PLACEHOLDER_IP_ADDRESS (string)",
"session_id": "PLACEHOLDER_SESSION_ID (string)",
"created_at": "PLACEHOLDER_CREATED_AT (string)",
"user": "PLACEHOLDER_USER (object)",
"api_key": "PLACEHOLDER_API_KEY (object)"
}
],
"total": "PLACEHOLDER_TOTAL (integer)",
"page": "PLACEHOLDER_PAGE (integer)",
"page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
"pages": "PLACEHOLDER_PAGES (integer)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/:id — Один запрос из истории
Доступ: Токен кабинета
/api/v1/usage/:idcurl --fail-with-body "https://ailoot.ai/api/v1/usage/$ID" \
-H "Authorization: Bearer $TOKEN"Параметры пути
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
id | integer | да |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: UsageLog. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"id": "PLACEHOLDER_ID (integer)",
"user_id": "PLACEHOLDER_USER_ID (integer)",
"api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
"request_id": "PLACEHOLDER_REQUEST_ID (string)",
"model": "PLACEHOLDER_MODEL (string)",
"service_tier": "PLACEHOLDER_SERVICE_TIER (string)",
"reasoning_effort": "PLACEHOLDER_REASONING_EFFORT (string)",
"input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
"output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
"cache_creation_tokens": "PLACEHOLDER_CACHE_CREATION_TOKENS (integer)",
"cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
"cache_creation_5m_tokens": "PLACEHOLDER_CACHE_CREATION_5M_TOKENS (integer)",
"cache_creation_1h_tokens": "PLACEHOLDER_CACHE_CREATION_1H_TOKENS (integer)",
"input_cost": "PLACEHOLDER_INPUT_COST (number)",
"output_cost": "PLACEHOLDER_OUTPUT_COST (number)",
"cache_creation_cost": "PLACEHOLDER_CACHE_CREATION_COST (number)",
"cache_read_cost": "PLACEHOLDER_CACHE_READ_COST (number)",
"total_cost": "PLACEHOLDER_TOTAL_COST (number)",
"actual_cost": "PLACEHOLDER_ACTUAL_COST (number)",
"long_context_billing_applied": "PLACEHOLDER_LONG_CONTEXT_BILLING_APPLIED (boolean)",
"request_type": "PLACEHOLDER_REQUEST_TYPE (string)",
"stream": "PLACEHOLDER_STREAM (boolean)",
"duration_ms": "PLACEHOLDER_DURATION_MS (integer)",
"first_token_ms": "PLACEHOLDER_FIRST_TOKEN_MS (integer)",
"image_count": "PLACEHOLDER_IMAGE_COUNT (integer)",
"image_size": "PLACEHOLDER_IMAGE_SIZE (string)",
"image_input_size": "PLACEHOLDER_IMAGE_INPUT_SIZE (string)",
"image_output_size": "PLACEHOLDER_IMAGE_OUTPUT_SIZE (string)",
"image_input_tokens": "PLACEHOLDER_IMAGE_INPUT_TOKENS (integer)",
"image_input_cost": "PLACEHOLDER_IMAGE_INPUT_COST (number)",
"image_output_tokens": "PLACEHOLDER_IMAGE_OUTPUT_TOKENS (integer)",
"image_output_cost": "PLACEHOLDER_IMAGE_OUTPUT_COST (number)",
"image_size_breakdown": "PLACEHOLDER_IMAGE_SIZE_BREAKDOWN (object)",
"media_type": "PLACEHOLDER_MEDIA_TYPE (string)",
"ip_address": "PLACEHOLDER_IP_ADDRESS (string)",
"session_id": "PLACEHOLDER_SESSION_ID (string)",
"created_at": "PLACEHOLDER_CREATED_AT (string)",
"user": "PLACEHOLDER_USER (object)",
"api_key": "PLACEHOLDER_API_KEY (object)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
POST /api/v1/usage/dashboard/api-keys-usage — Статистика собственных API-ключей
Доступ: Токен кабинета
/api/v1/usage/dashboard/api-keys-usageПоля JSON / формы
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
api_key_ids | array | да | required |
{
"api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}PLACEHOLDER обозначает ваш ввод и его тип. Замените значения и оставьте только нужные необязательные поля; строковые маркеры не отправляются вместо чисел, boolean, объектов или массивов.
Схема запроса: BatchAPIKeysUsageRequest
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: BatchAPIKeyUsageStats. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
"today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
"total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
Особенности: Метод читает статистику собственных API-ключей; пример описывает контракт и не выполняется.
GET /api/v1/usage/dashboard/models — Использование по моделям
Доступ: Токен кабинета
/api/v1/usage/dashboard/modelscurl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/models" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
api_key_id | integer | нет | |
request_type | string | нет | |
stream | boolean | нет | |
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
period | string | нет | |
model | string | нет |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
{
"code": 0,
"message": "success",
"data": {
"end_date": "VALUE_FROM_RESPONSE",
"models": "VALUE_FROM_RESPONSE",
"month": "VALUE_FROM_RESPONSE",
"start_date": "VALUE_FROM_RESPONSE",
"today": "VALUE_FROM_RESPONSE",
"week": "VALUE_FROM_RESPONSE"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/dashboard/snapshot-v2 — Единый снимок графиков
Доступ: Токен кабинета
/api/v1/usage/dashboard/snapshot-v2curl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/snapshot-v2" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
granularity | string | нет | ; по умолчанию: day |
include_trend | boolean | нет | ; по умолчанию: true |
include_model_stats | boolean | нет | ; по умолчанию: true |
api_key_id | integer | нет | |
request_type | string | нет | |
stream | boolean | нет | |
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
period | string | нет | |
model | string | нет |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
{
"code": 0,
"message": "success",
"data": {
"end_date": "VALUE_FROM_RESPONSE",
"generated_at": "VALUE_FROM_RESPONSE",
"granularity": "VALUE_FROM_RESPONSE",
"month": "VALUE_FROM_RESPONSE",
"start_date": "VALUE_FROM_RESPONSE",
"today": "VALUE_FROM_RESPONSE",
"week": "VALUE_FROM_RESPONSE"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/dashboard/stats — Итоги использования
Доступ: Токен кабинета
/api/v1/usage/dashboard/statscurl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/stats" \
-H "Authorization: Bearer $TOKEN"Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: UserDashboardStats. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"total_api_keys": "PLACEHOLDER_TOTAL_API_KEYS (integer)",
"active_api_keys": "PLACEHOLDER_ACTIVE_API_KEYS (integer)",
"total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
"total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
"total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
"total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
"total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
"total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
"total_cost": "PLACEHOLDER_TOTAL_COST (number)",
"total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
"today_requests": "PLACEHOLDER_TODAY_REQUESTS (integer)",
"today_input_tokens": "PLACEHOLDER_TODAY_INPUT_TOKENS (integer)",
"today_output_tokens": "PLACEHOLDER_TODAY_OUTPUT_TOKENS (integer)",
"today_cache_creation_tokens": "PLACEHOLDER_TODAY_CACHE_CREATION_TOKENS (integer)",
"today_cache_read_tokens": "PLACEHOLDER_TODAY_CACHE_READ_TOKENS (integer)",
"today_tokens": "PLACEHOLDER_TODAY_TOKENS (integer)",
"today_cost": "PLACEHOLDER_TODAY_COST (number)",
"today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
"average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
"rpm": "PLACEHOLDER_RPM (integer)",
"tpm": "PLACEHOLDER_TPM (integer)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/dashboard/trend — Динамика использования
Доступ: Токен кабинета
/api/v1/usage/dashboard/trendcurl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/trend" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
granularity | string | нет | ; по умолчанию: day |
api_key_id | integer | нет | |
request_type | string | нет | |
stream | boolean | нет | |
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
period | string | нет | |
model | string | нет |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
{
"code": 0,
"message": "success",
"data": {
"end_date": "VALUE_FROM_RESPONSE",
"granularity": "VALUE_FROM_RESPONSE",
"month": "VALUE_FROM_RESPONSE",
"start_date": "VALUE_FROM_RESPONSE",
"today": "VALUE_FROM_RESPONSE",
"trend": "VALUE_FROM_RESPONSE",
"week": "VALUE_FROM_RESPONSE"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/errors — История ошибок
Доступ: Токен кабинета
/api/v1/usage/errorscurl --fail-with-body "https://ailoot.ai/api/v1/usage/errors" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
model | string | нет | |
api_key_id | integer | нет | |
status_code | integer | нет | |
category | string | нет | |
sort_by | string | нет | |
sort_order | string | нет | |
page | integer | нет | ; по умолчанию: 1; positive; page_size/limit <=1000 |
page_size | integer | нет | ; по умолчанию: 20; positive; page_size/limit <=1000 |
limit | integer | нет | ; по умолчанию: 20; positive; page_size/limit <=1000 |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
{
"code": 0,
"message": "success",
"data": {
"items": [
"PLACEHOLDER_DATA (object, описание — на странице «Схемы данных»)"
],
"total": "PLACEHOLDER_TOTAL (integer)",
"page": "PLACEHOLDER_PAGE (integer)",
"page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
"pages": "PLACEHOLDER_PAGES (integer)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/errors/:id — Подробности собственной ошибки
Доступ: Токен кабинета
/api/v1/usage/errors/:idcurl --fail-with-body "https://ailoot.ai/api/v1/usage/errors/$ID" \
-H "Authorization: Bearer $TOKEN"Параметры пути
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
id | integer | да |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
{
"code": 0,
"message": "success",
"data": "PLACEHOLDER_DATA (object, описание — на странице «Схемы данных»)"
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/usage/stats — Статистика использования
Доступ: Токен кабинета
/api/v1/usage/statscurl --fail-with-body "https://ailoot.ai/api/v1/usage/stats" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
api_key_id | integer | нет | |
request_type | string | нет | |
stream | boolean | нет | |
timezone | string | нет | |
start_date | string | нет | |
end_date | string | нет | |
period | string | нет | |
model | string | нет |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: UsageStats. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
"total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
"total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
"total_cache_tokens": "PLACEHOLDER_TOTAL_CACHE_TOKENS (integer)",
"total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
"total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
"total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
"total_cost": "PLACEHOLDER_TOTAL_COST (number)",
"total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
"average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
"endpoints": "PLACEHOLDER_ENDPOINTS (array)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
GET /api/v1/user/api-keys/:id/usage/daily — Дневная статистика собственного API-ключа
Доступ: Токен кабинета
/api/v1/user/api-keys/:id/usage/dailycurl --fail-with-body "https://ailoot.ai/api/v1/user/api-keys/$ID/usage/daily" \
-H "Authorization: Bearer $TOKEN"Параметры пути
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
id | integer | да |
Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
days | integer | нет | ; по умолчанию: 30 |
timezone | string | нет |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: APIKeyDailyUsagePoint. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"date": "PLACEHOLDER_DATE (string)",
"requests": "PLACEHOLDER_REQUESTS (integer)",
"input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
"output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
"cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
"cache_write_tokens": "PLACEHOLDER_CACHE_WRITE_TOKENS (integer)",
"total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
"cost": "PLACEHOLDER_COST (number)",
"actual_cost": "PLACEHOLDER_ACTUAL_COST (number)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
История и расходы · USD
total_cost — расчётная стоимость по тарифу; actual_cost — записанная сумма списания в USD.
Пример расчёта
{
"total_cost": 0.1,
"actual_cost": 0.08
}period ∈ {today, week, month}; start_date, end_date: YYYY-MM-DD; timezone: IANA · timezone=UTC. end_date: [00:00, +1 day 00:00). display: actual_cost.toFixed(8); JSON: number.