Кредиты и использование
Платные услуги оплачиваются с помощью кредитов аккаунта. Суммы указаны в милликредитах (millicredits); 1000 милликредитов равны 1 кредиту. Суммы, указываемые в запросах, должны быть целыми числами; суммы в балансах и записях могут содержать одно десятичное знаком (0,1 милликредита). Значение credit_precision в ответах равно 4, то есть после преобразования в кредиты оно содержит не более 4 знаков после запятой.
Проверьте баланс
Заголовок раздела «Проверьте баланс»GET /api/v1/billing/credits/balancecurl 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_v4 | 3,000 | ¥9.90 | — |
credits_10000_v4 | 10,000 | ¥29.90 | — |
credits_25000_v4 | 25,000 | ¥69 | 8% |
credits_50000_v4 (рекомендуется) | 50,000 | ¥129 | 16% |
credits_125000_v4 | 125,000 | ¥299 | 25% |
credits_450000_v4 | 450,000 | ¥999 | 35% |
- «Бонус» рассчитывается исходя из цены 10 000 кредитов — 29,90 ¥ и соответствует полю
bonus_percent; рекомендуемый пакет имеет значениеrecommended: true. Ни одно из этих полей не отображается, если оно не задано. price_fen(в фэнях, 1/100 юаня) является официальной единицей измерения цены, аtotal_millicredits(милликредиты) — единицей кредитов. Приобретённые кредиты не истекают; пакеты можно покупать повторно, и каждый раз они поступают одним заказом.
Цикл зарядки
Заголовок раздела «Цикл зарядки»- Баланс проверяется на соответствие пороговому значению перед запуском задания : баланс (за вычетом долга) должен превышать пороговое значение для данного задания; например, для перевода PDF — «количество страниц × 2 кредита», для других файлов — длина исходного текста (не менее 2 кредитов), а для аудио, видео и речи — стоимость, рассчитанная по длительности или количеству символов, измеренная сервером (цены в аудио, видео и голоса ). При наличии API‑ключа с установленным бюджетом остаток бюджета этого ключа также должен превышать пороговое значение. В противном случае ответ имеет статус
402(задание по переводу файла завершается с ошибкойquota_exceeded=true, медиазадание завершается с ошибкойerror_code=insufficient_credits), и плата не взимается. Запуск задания не изменяет баланс. - Фактическое использование тарифицируется по его завершении : перевод файлов (включая изображения), пакетная обработка богатого текста, операции с документами, аудио, видео и речь тарифицируются полностью по фактическому использованию после завершения. Бюджет API‑ключа участвует только в проверке перед запуском и никогда не уменьшает сумму начисленной платы за завершённую задачу; если это приводит к тому, что использованный бюджет ключа превышает установленный лимит, ключ не может запускать новые задачи до повышения лимита. Неудавшиеся или отменённые задачи не тарифицируются.
- Баланс может стать отрицательным : часть фактических затрат, превышающая баланс, фиксируется как долг, и баланс отображается как отрицательный; поступившие позже кредиты сначала используются для погашения долга. Новые задания не могут быть начаты, пока баланс отрицательный; пополните счет.
Клиенты никогда не указывают «какую сумму следует начислить»; сервер вычисляет окончательную сумму на основе фактически предоставленных услуг.
Операции и записи
Заголовок раздела «Операции и записи»GET /api/v1/billing/credits/operations?limit=20GET /api/v1/billing/credits/operations/{operation_id}GET /api/v1/billing/credits/jobs/{job_id}Запись содержит идентификатор операции, статус, базу для выставления счета, а также начисленные и возвращённые суммы. При указании API‑ключа в списке отображаются только операции, инициированные этим ключом.
Использование
Заголовок раздела «Использование»GET /api/v1/usage?limit=50GET /api/v1/usage/summaryКонечные точки использования возвращают количество файлов, символов, токенов и время обработки для данной учётной записи.
Запросы бесплатны
Заголовок раздела «Запросы бесплатны»Проверка баланса, статуса заданий, использования, записей расчетов, списков результатов и адресов загрузки не потребует кредитов.