BeatAPIEffect APIEffect API

Effect API

Create an asynchronous image or video Effect task using a versioned BeatAPI effect. Before creating a task, read the Effect catalog to confirm image count, output type, supported options, and version. If an input is local, [upload a local input](/quick-guide#upload-an-input-file). Save `data.id`, [poll the Task](/quick-guide#get-task-status), and follow the [error and retry policy](/quick-guide#errors-and-retry-policy).

身份验证

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

请求头

Idempotency-Keystring可选<=255 characters

请求

This endpoint expects an object.
effect_idstring必需

Stable published Effect ID from GET /v1/effects.

imageslist of strings必需

Public HTTPS input images in the order required by the selected Effect version. Read GET /v1/effects/{effect_id} for the exact count and accepted media rules; upload local files with POST /v1/files.

effect_versioninteger可选>=1
Optional immutable version. Omit to use the current published version.
optionsobject可选

Optional controls supported by the selected Effect version. Omit unsupported controls; the catalog is the source of truth.

响应

Effect task accepted
dataobject
Accepted or current BeatAPI task state.

错误

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error