ナビゲーションにスキップ
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. Save data.id, poll the Task, and follow the error 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
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error