Перейти к навигации
BeatAPIEffect APIEffect API

API эффектов

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

Перед созданием прочитайте каталог эффектов и проверьте число изображений, тип результата, поддерживаемые настройки и версию. Если исходный файл локальный, загрузите его. Сохраните data.id, опрашивайте задачу и соблюдайте правила обработки ошибок и повторов.

Аутентификация

AuthorizationBearer

Передавайте API-ключ в виде Authorization: Bearer <BEATAPI_API_KEY>.

Заголовки

Idempotency-KeystringОпциональный<=255 characters

Необязательно, не более 255 символов (превышение приводит к 400 bad_request). В течение 24 часов тот же ключ с идентичным запросом воспроизводит первый успешный ответ с Idempotent-Replayed: true; тот же ключ с другим телом или путём возвращает 409 idempotency_conflict, как и ключ, первоначальный запрос с которым ещё выполняется. Ответы не-2xx не сохраняются.

Запрос

This endpoint expects an object.
effect_idstringОбязательный

Стабильный опубликованный идентификатор эффекта из GET /v1/effects.

imageslist of stringsОбязательный

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

effect_versionintegerОпциональный>=1

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

optionsobjectОпциональный

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

Ответ

Задача эффекта принята

dataobject

Принятое или текущее состояние задачи BeatAPI.

Ошибки

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error