API эффектов

POST https://api.beatapi.io/v1/effects/tasks

Создайте асинхронную задачу эффекта для изображения или видео, используя версию эффекта BeatAPI.

Авторизация

Authorization   string   обязательный

Передавайте API-ключ BeatAPI как токен Bearer. Создать ключ можно в панели управления.

Authorization: Bearer <BEATAPI_API_KEY>

Храните постоянные API-ключи на доверенных серверах. Для тела запроса обязателен Content-Type: application/json. Если метод принимает Idempotency-Key, этот заголовок необязателен, но рекомендуется для безопасных повторных попыток с точно таким же телом.

Тело запроса

effect_id   string   обязательный

Постоянный опубликованный ID эффекта из GET /v1/effects.

effect_version   integer   необязательный

Необязательная неизменяемая версия. Если не указана, используется текущая опубликованная версия.

Диапазон: x >= 1

images   string[]   обязательный

Общедоступные HTTPS-ссылки на входные изображения в порядке, требуемом выбранной версией эффекта. Точное число и ограничения медиа приведены в GET /v1/effects/{effect_id}. Локальные файлы загружайте через POST /v1/files.

Количество: 1 – 7 элементов

options   object   необязательный

Необязательные настройки, поддерживаемые выбранной версией эффекта. Не передавайте неподдерживаемые настройки; ориентируйтесь на каталог.

options.aspect_ratio   string   необязательный

Соотношение сторон результата, если выбранный эффект поддерживает эту настройку.

options.resolution   string   необязательный

Разрешение результата, если выбранный эффект поддерживает эту настройку.

options.duration   integer   необязательный

Длительность видео в секундах, если выбранный эффект поддерживает эту настройку.

options.bgm   boolean   необязательный

Добавить фоновую музыку, если выбранный эффект это поддерживает.

options.seed   integer   необязательный

Необязательное начальное значение генератора для воспроизводимости, если выбранный эффект его поддерживает.

Ответ

Успешный запрос возвращает HTTP 201.

{
  "data": {
    "id": "task_effect123",
    "object": "task",
    "task_kind": "effect",
    "capability_id": "video-muscle-max",
    "capability_version": 1,
    "effect_id": "video-muscle-max",
    "effect_version": 1,
    "status": "queued",
    "stage": "queued",
    "created_at": 1782210000,
    "updated_at": 1782210000,
    "completed_at": null,
    "output": null,
    "usage": {
      "credits_reserved": 1.2,
      "credits_charged": 1.2,
      "credits_settled": 0,
      "credits_refunded": 0
    },
    "request_id": "req_effect123",
    "error_code": null,
    "error_message": null
  }
}

Следующий шаг

Сохраните data.id из ответа о принятии задачи и опрашивайте GET /v1/tasks/{task_id} каждые 5–10 секунд, пока status не станет succeeded или failed. Готовые файлы находятся в data.output.media.

Ошибки