Генерация видео

Запрос на генерацию видео файла

Позволяет отправить запрос на генерацию видео файла с соответствующим video_id. В данном запросе вы можете заменить некоторые значения в видеоролике, например текст или изображение, с помощью массива overrides. Список доступных значений для замены вы можете посмотреть здесь.

Ответ на запрос возвращает url, по которому можно отслеживать статус генерации.

POST https://dashboard.supa.ru/api/videos/:video_id/render/?api_key=YOUR_API_KEY&v=1.0

{
  "parameters": { 
    "fps": 60, // 30 или 60 кадров в секунду
    "size_type": "hd" // hd - высокое качество, sd - обычное качество
  },
  "overrides": [ 
    {
      "name": "username", // Имя объекта заданное в редакторе
      "object": { // Настройки объекта
        "text": "Максим" // Заменяем текст в ролике
      }
    },
    {
      "name": "slide_1", // Имя слайда заданное в редакторе
      "slide": { // Настройки слайда
        "path": "https://supa-uploads.s3.eu-central-1.amazonaws.com/1/api/fardcydpebzg.png" // Заменяем фон слайда
      }
    }
  ]
}

Пример ответа

{
  "result": "true",
  "task_url": "https://dashboard.supa.ru/api/queue/23455/",  // URL для отслеживания готовности
  "task_id": 23455
}

Коды ответа

Код Сообщение Описание
202 - Успешно. Запрос на генерацию видео принят. Ответ включает в себя task_url и task_id
400 incorrect_data Некорректные параметры data или parameters
402 insufficient_funds Недостаточно средств на балансе
403 auth_required Неправильный API-ключ
429 daily_limit_exceeded Превышено количество запросов в сутки
5хх - Ошибка сервера

По умолчанию вы можете отправить 1000 успешных запросов на генерацию ролика в сутки в платном режиме и 30 запросов в день на бесплатном режиме. Если этого объема недостаточно для вашей задачи, то мы можем расширить максимальное количество запросов на платном режиме. Для этого обратитесь в поддержку.

Отслеживание готовности видео

Генерация видео занимает некоторое время, поэтому после отправки запроса на генерацию, нам нужно дождаться окончания рендеринга видео, отправляя периодические запросы на task_url.

GET https://dashboard.supa.ru/api/queue/:task_id/?api_key=YOUR_API_KEY&v=1.0

{  
  "id": 926, // id задачи
  "video_id": 563, // id видео
  "user_id": 1, // id пользователя
  "wait_time": 3.684, // Время в очереди
  "billed_duration": 5, // Продолжительность ролика в секундах
  "billed_price": 5, // Стоимость генерации ролика, списанная с баланса
  "exec_time": 33.2, // Время генерации видео. Отсчитывается от момента перехода из queued в статус pending
  "screenshot_url": "https://s3.eu-central-1.amazonaws.com/supa-uploads/1/zpuaqxifztgr_screenshot.jpg",  // URL для превьюшки
  "video_url": "https://s3.eu-central-1.amazonaws.com/supa-temp/1/yqiiaxpbuirw.mp4", // URL видео
  "start_date": "2018-10-17T08:56:36.678Z", // Дата добавления задачи
  "state_date": "2018-10-17T08:57:12.795Z", // Дата обновления статуса
  "state": "done" // Статус задачи, ниже описание возможных значений
}

Коды ответа

Код Сообщение Описание
200 - Успешно. Выводит информацию о задаче и статус генерации
403 auth_required Неправильный API-ключ
404 not_found id задачи не найден (task_id)
5хх - Ошибка сервера

URL готового ролика содержится в параметре video_url. Ролик хранится на сервере в течение 30 дней.

Количество видеороликов, которое может генерироваться одновременно, определяется количеством потоков. По умолчанию количество потоков равно 1, т.е. вы можете отправить несколько запросов на генерацию, но они будут обрабатываться один за другим, в порядке очереди. Соответственно, если потоков будет больше, например 2, то очередь будет обрабатываться быстрее, потому что одновременно в работе будет 2 запроса.

Статусы задачи (state)

Статус Описание
queued Поставлено в очередь. Статус по умолчанию
pending Генерация в процессе
done Генерация выполнена. video_url содержит URL видео
error Ошибка генерации видео. Требуется повторный запуск задачи.

Бесплатная версия

Даже если ваш баланс равен нулю, то вы все равно можете генерировать видеоролики, но с некоторыми ограничениями.

В бесплатной версии вы можете генерировать не более 30 роликов в сутки: вам доступно только обычное качество, формат mp4 и частота 30 кадров в секунду.Также на ролике будет располагаться логотип SUPA. Данный вариант отлично подходит для отладки скриптов без необходимости вносить оплату.

Чтобы сгенерировать ролик в рамках бесплатной версии, необходимо отправить параметр demo: true. С этим параметром деньги не будут списываться даже в случае положительного баланса.

POST https://dashboard.supa.ru/api/videos/:video_id/render?api_key=YOUR_API_KEY&v=1.0

{
  "parameters": {
    "size_type": "sd",
    "demo": true
  },
  "overrides": [
    // Замены значений в ролике
  ]
}

Параметры генерации видео

Параметр Значения По умолчанию Описание
size_type "sd", "hd" "sd" Качество ролика SD или HD
fps 30, 60 30 Количество кадров в секунду (частота)
demo true/false false Бесплатная версия

Обратите внимание, что в зависимости от данных параметров может измениться стоимость генерации.