Перейти до вмісту

Кредити та використання

Тарифіковані послуги оплачуються у вигляді кредитів на рахунку. Суми наводяться в мілікредитах (millicredits); 1000 мілікредитів дорівнюють 1 кредиту. Суми, які ви надсилаєте в запитах, мають бути цілими числами; суми на балансах та в записах можуть мати одну десяткову позицію (0,1 мілікредиту). credit_precision у відповідях становить 4, що означає максимум 4 десяткові знаки після перетворення на кредити.

GET /api/v1/billing/credits/balance
Terminal window
curl https://omnidoc.top/api/v1/billing/credits/balance \
-H "X-API-Key: $OMNIDOC_API_KEY"

Ключові поля:

ПолеЗначення
availableМілікредити доступні зараз, після сплати боргу; від’ємне значення — при наявності боргу
debtЗаборгованість у мілікредитах: частина фактичної вартості завершених завдань, що перевищила залишок. Кредити, які надходять пізніше (доповнення балансу, щоденні гранти, коди для обміну, повернення коштів тощо), спочатку списуються на погашення заборгованості.
spentЗагальна сума мілікредитів, яка була сплачена
expiredМілікредити, які закінчилися або були списані
today_chargedМілікредити було зараховано сьогодні
lotsДіючі кредитні лоти та їх термін дії
GET /api/v1/billing/credits/plans

Публічна кінцева точка, яка не вимагає входу та повертає набори у продажу (purchase_plans, індексовані за кодом плану). Зараз у продажу:

Код плануКредитиЦінаБонус
credits_3000_v43,000¥9.90—
credits_10000_v410,000¥29.90—
credits_25000_v425,000¥698%
credits_50000_v4 (рекомендовано)50,000¥12916%
credits_125000_v4125,000¥29925%
credits_450000_v4450,000¥99935%
  • «Бонус» розраховується від ціни 10 000 кредитів у розмірі ¥29,90 і відповідає полю bonus_percent; рекомендований пакет має значення recommended: true. Жодне з цих полів не відображається, якщо воно не встановлено.
  • price_fen (у фенах, 1/100 юаня) є авторитетним для ціни, а total_millicredits (мілікредити) — для кредитів. Придбані кредити не мають терміну дії; пакети можна купувати знову, і кожен раз вони надходять одним замовленням.

Життєвий цикл заряджання

Section titled “Життєвий цикл заряджання”
  1. Баланс перевіряється відносно порогового значення перед початком завдання : баланс (після боргу) має бути вище порогового значення завдання, наприклад «сторінки × 2 кредити» для перекладу PDF, довжина вихідного тексту для інших файлів (щонайменше 2 кредити), а для аудіо, відео та мовлення — вартість, обчислена на основі тривалості або кількості символів, яку виміряв сервер (ціни в аудіо, відео та голоси ). За наявності API-ключу з бюджетом залишок бюджету ключа також має перевищувати порогове значення. В іншому разі відповідь є 402 (завдання з перекладу файлу завершується з помилкою quota_exceeded=true, завдання з мультимедіа завершується з помилкою error_code=insufficient_credits), і жодна сума не стягується. Початок завдання не змінює баланс.
  2. Фактичне використання тарифікується після його завершення : переклад файлів (включаючи зображення), пакетна робота з форматованим текстом, операції над документами, аудіо, відео та мова тарифікуються повністю за фактичне використання після завершення. Бюджет API-ключів враховується лише під час перевірки перед початком і ніколи не зменшує суму оплати за завершену задачу; якщо це призведе до того, що використаний бюджет ключа перевищить його ліміт, ключ не зможе запускати нові завдання, поки ліміт не буде збільшено. Завдання, що завершилися з помилкою або були скасовані, не тарифікуються.
  3. Залишок може стати від’ємним : частина фактичної вартості, що перевищує залишок, фіксується як борг, і залишок відображається як від’ємний; надходження кредитів пізніше спочатку сплачують цей борг. Нові завдання не можуть початися, поки залишок є від’ємним; поповніть.

Клієнти ніколи не надсилають запит «скільки слід нарахувати»; сервер обчислює підсумкову суму на основі фактично наданих послуг.

GET /api/v1/billing/credits/operations?limit=20
GET /api/v1/billing/credits/operations/{operation_id}
GET /api/v1/billing/credits/jobs/{job_id}

Запис містить ідентифікатор операції, статус, базу для нарахування та суми списання й повернення. За наявності API-ключу в списку операцій будуть лише ті, які були ініційовані цим ключем.

GET /api/v1/usage?limit=50
GET /api/v1/usage/summary

Конечні точки використання повертають кількість файлів облікового запису, символи, токени та час обробки.

Перевірка балансу, статусу завдань, використання, записів розрахунків, списків результатів та адрес завантаження не споживає кредити.