Перейти к содержанию

Справочник API

Все эндпоинты Slicer API v1 по группам — метод, путь, области доступа, лимит, цена, параметры, ответы и примеры на curl, JavaScript и Python.

На этой странице

Справочник строится из спецификации OpenAPI 3.1, которую отдаёт сам сервер, — описание и поведение API не расходятся. Скачать спецификацию для генератора клиентов или Postman можно без токена: https://api.slicer.media/v1/openapi.json (откроется в новой вкладке).

Группы

Группа Что внутри
Аккаунтпрофиль, баланс, токен, операции кошелька
Каталог и ценыстили и настройки монтажа, пресеты экспорта, цена операции, спецификация
Загрузкизагрузка файлов целиком, по частям, по ссылке и по адресу
Проектымонтаж, статус, версии, пересборка, повтор, остановка, скачивание
Правкитекст ролика, операции правок, документ монтажа, ИИ-помощник, перевод, стиль
Экспорт и публикациярендер ролика, публикации, подключённые соцсети
Вебхукиадреса уведомлений, проверка и журнал доставок

Как читать описание эндпоинта

  • Метод и путь — относительно https://api.slicer.media; параметры пути — в фигурных скобках.
  • Области — какие области доступа нужны токену. «Любая» — достаточно любого действующего токена.
  • Лимит — корзина лимита запросов: обычные, платные или части загрузки.
  • Цена — у платных эндпоинтов: без confirmCost ответ — цена Quote, ничего не запускается (Монтаж и цена). У субтитров из речи, ИИ-помощника и перевода цена — себестоимость ИИ: в Quote есть estimate (ожидаемая) и atCost: true, а cost — предельная цена (Правки ролика).
  • Ответ — содержимое поля data успешного ответа { "ok": true, "data": … }. Ошибки — в общем формате (Ошибки).

Все запросы с телом отправляют JSON (Content-Type: application/json), кроме загрузки файлов — там тело — байты файла (application/octet-stream).

Общие схемы

Quote

Поле Тип Описание
statusобязательное"quote"
costобязательноеintegerЦена в токенах; повторите запрос с confirmCost, равным ей. У операции по себестоимости (atCost) — предельная: спишется фактическая себестоимость, не больше
freeобязательноеbooleanОперация бесплатна (первый ролик, бесплатный повтор)
estimatenumberОперация по себестоимости: ожидаемая цена в токенах (дробно)
atCostbooleanЦена — себестоимость ИИ-сервисов без наценки: списывается фактическая, не больше cost
availableобязательноеintegerСколько токенов доступно сейчас
enoughобязательноеbooleanТокенов хватает
spendLimitLeftобязательноеinteger | nullОстаток месячного лимита расходов токена; null — без лимита

Error

Поле Тип Описание
okобязательноеfalse
errorобязательноеobject
error.codeобязательноеstringСтабильный код ошибки в snake_case
error.messageобязательноеstringПонятный текст на языке аккаунта
error.fieldsRecord<string, string>Ошибки по полям
error.retryAfterSecintegerЧерез сколько секунд повторить

Что дальше