Перейти к содержимому
Agentum Cloud для разработчиков

Usage Quota

GET
/v1/usage/quota
curl --request GET \
  --url https://api.cloud.agentums.ru/v1/usage/quota \
  --header 'Authorization: Bearer <token>'

Остаток месячного лимита (B2, «кольцо использования») за текущий календарный месяц.

Всегда — документы и минуты аудио. План берётся из активной подписки, иначе free.

chat_messages появляется, ТОЛЬКО когда лимит ходов чата действительно применяется к этому владельцу. Обычно его нет: по протоколу §6.1 чат не тарифицируется, а флаг CHAT_QUOTA_ENFORCED — анти-абьюз для ботов, и на своём ключе владельца он не действует. Клиенту это поле нужно ровно для того, чтобы не обещать безлимит, когда потолок включён: отсутствие поля значит «ограничения нет», а не «оно бесконечно».

Authorizations

Заголовок раздела «Authorizations»

Responses

Заголовок раздела «Responses»

200

Заголовок раздела «200»

Successful Response

Media typeapplication/json
QuotaOut

Данные «кольца использования» (B2): месячные лимиты и остаток по плану.

object
audio_minutes
required
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
chat_messages
Any of:
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
documents
required
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
period
Period
string
default: month
plan
Plan
string
default: free
storage_bytes
Any of:
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
tokens
Any of:
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
tokens_messages_left
Any of:
integer
tokens_warning
Tokens Warning
boolean
web_searches
Any of:
QuotaResource

Остаток по ресурсу за месяц (B2). limit=None — безлимит (fair-use).

object
limit
Any of:
integer
remaining
Any of:
integer
used
Used
integer
0
Example
{
  "audio_minutes": {
    "used": 0
  },
  "chat_messages": {
    "used": 0
  },
  "documents": {
    "used": 0
  },
  "period": "month",
  "plan": "free",
  "storage_bytes": {
    "used": 0
  },
  "tokens": {
    "used": 0
  },
  "tokens_warning": false,
  "web_searches": {
    "used": 0
  }
}

422

Заголовок раздела «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}