Public API

Получить использование моделей

Возвращает посуточные (UTC) сегменты использования моделей в пределах видимости использованного API-ключа. Без `group_by[]` возвращаются суточные итоги.

GET
/public/v1/model-usage

Authorization

BearerAuth
AuthorizationBearer <token>

Use an Atlas Cloud API key in the form Authorization: Bearer apikey-....

In: header

Query Parameters

start_date*string

Inclusive UTC start date in YYYY-MM-DD format.

Formatdate
end_date*string

Exclusive UTC end date in YYYY-MM-DD format. The range can cover at most 180 daily buckets.

Formatdate
scope?string

Visibility scope. self reads usage from the authenticated user's API keys. account requires account-level billing read permission.

Default"self"

Value in

  • "self"
  • "account"
group_by[]?array<>

Repeated grouping parameter. Omit to return total daily buckets. Supported sets are model_type, model, api_key, and model plus api_key. Comma-delimited values are not accepted.

Itemsitems <= 3
model_types[]?array<>

Repeated model type filter. Omit to include text, image, and video.

Itemsitems <= 3
model_ids[]?array<string>

Repeated model ID filter. At most 100 IDs.

Itemsitems <= 100
api_key_ids[]?array<string>

Repeated API key public ID filter. Use ak_... IDs returned by API key management, not the secret apikey-... token.

Itemsitems <= 100
limit?integer

Maximum number of grouped rows to return.

Range1 <= value <= 1000
Default100
page?string

Opaque cursor from the previous response's next_page. Pass it back unchanged.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/public/v1/model-usage?start_date=2026-05-01&end_date=2026-05-08&group_by%5B%5D=model&group_by%5B%5D=api_key&model_types%5B%5D=text&model_types%5B%5D=image&model_ids%5B%5D=deepseek-v3&api_key_ids%5B%5D=ak_abc123"
{  "object": "list",  "scope": "self",  "data": [    {      "object": "usage.bucket",      "date": "2026-05-01",      "start_at": "2026-05-01T00:00:00Z",      "end_at": "2026-05-02T00:00:00Z",      "covered_until": "2026-05-02T00:00:00Z",      "partial": false,      "results": [        {          "object": "usage.result",          "usage": {            "requests": 12,            "tokens": {              "input": 12000,              "output": 3000,              "total": 15000,              "cache_creation": 0,              "cache_creation_1h": 0,              "cache_read": 0,              "input_image": 0,              "output_image": 0            },            "images": null,            "video": null          }        }      ]    }  ],  "has_more": false,  "next_page": null,  "request_id": "req_123"}

Last updated on

Получить баланс аккаунта GET

Возвращает текущий баланс и сводку по начисленным кредитам для аккаунта, которому принадлежит использованный API-ключ.

Получить расходы по моделям GET

Возвращает посуточные (UTC) сегменты расходов на модели в пределах видимости использованного API-ключа. Без `group_by[]` возвращаются суточные итоги.