Получить остаток токенов

Обновлено 16 декабря 2024

Скачать спецификацию

GET

/balance

Возвращает доступный остаток токенов для каждой из моделей. Метод доступен только при покупке пакетов токенов. Если вы оплачиваете работу с API по схеме pay-as-you-go, запрос вернет ошибку 403 Permission Denied.

Подробнее о пакетах токенов — в разделах платные пакеты для физических лиц или для ИП и юридических лиц.

Запрос

Header Parameters

X-Request-ID
string
X-Session-ID
string

Ответы

• 200
• 401
• 403

OK

• application/json

• Схема
• Пример из схемы

Schema

balance object[]
Array [
usage
string
Название модели, например, GigaChat или embeddings.
value
integer
Остаток токенов
]

{
  "balance": [
    {
      "usage": "GigaChat",
      "value": 100500
    }
  ]
}

Ошибка авторизации.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 401

HTTP-код сообщения.

message

string

По умолчанию: Unauthorized

Описание ошибки.

{
  "status": 401,
  "message": "Unauthorized"
}

Ошибка доступа. Возникает возникает при отправке запроса если вы оплачиваете работу с API по схеме pay-as-you-go.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 403

HTTP-код сообщения.

message

string

По умолчанию: Permission denied

Описание ошибки.

{
  "status": 403,
  "message": "Permission denied"
}

Loading...

Loading...