ナビゲーションにスキップ
BeatAPIEcommerce VideoWorkflow API

Ecommerce Video

Create an Ecommerce Video workflow task from product images and an explicit output duration.

If an input is local, upload a local input and use the returned data.url. 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オプション

Optional retry key. Reusing the same key with the same request body returns the accepted task; reusing it with a different body returns 409 idempotency_conflict.

リクエスト

This endpoint expects an object.
imageslist of strings必須

Primary product or scene image first, followed by up to six additional public HTTPS PNG, JPEG, or WebP product or lifestyle images. Upload local files with POST /v1/files and use the returned data.url.

durationinteger必須10-60

Required target output duration in seconds and the basis for USD calculation. Allowed range is 10-60 seconds.

promptstringオプション<=2000 characters
Optional creative direction, audience, product benefit, offer, tone, scenes, or call to action. Maximum 2000 characters.
aspect_ratioenumオプション

Target output placement. Use 16:9 for landscape, 9:16 for vertical social, or 1:1 for square placements; set explicitly for stable layout.

許可された値:
languageenumオプション

Dialogue and narration language. Use en for English or zh for Chinese; set explicitly when the prompt contains mixed languages.

許可された値:

レスポンス

Task accepted
dataobject
Accepted or current BeatAPI task state.

エラー

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