> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# 商品紹介動画

> 商品画像と明示的な出力の長さを指定して、商品紹介動画のワークフロータスクを作成します。

`POST https://api.beatapi.io/v1/ecommerce-video/tasks`

商品画像と明示的な出力の長さを指定して、商品紹介動画のワークフロータスクを作成します。

## 認証

`Authorization`   `string`   **必須**

BeatAPI の API キーを Bearer トークンとして送信します。API キーは[ダッシュボード](https://beatapi.io/dashboard)で作成できます。

```
Authorization: Bearer <BEATAPI_API_KEY>
```

通常の API キーは、信頼できるサーバーで管理してください。リクエストボディには `Content-Type: application/json` が必要です。対応するエンドポイントでは `Idempotency-Key` は任意ですが、同一のリクエストボディで安全に再試行するために指定を推奨します。

## リクエストボディ

`images`   `string[]`   **必須**

メインの商品画像またはシーン画像を最初に指定し、続けて最大 6 枚の商品・利用シーン画像を指定します。公開 HTTPS の PNG・JPEG・WebP に対応しています。ローカルファイルは `POST /v1/files` でアップロードし、返された `data.url` を使用してください。

**要素数:** 1 – 7 件

---

`duration`   `integer`   **必須**

出力動画の目標の長さを秒単位で指定します。必須フィールドで、米ドル建て料金の計算基準にもなります。指定できる範囲は 10～60 秒です。

**範囲:** 10 – 60

---

`prompt`   `string`   **任意**

制作方針、対象ユーザー、商品の利点、オファー、トーン、シーン、行動を促すメッセージなどを任意で指定します。最大 2000 文字です。

**文字数:** 最大 2000 文字

---

`aspect_ratio`   `enum<string>`   **任意**

掲載先に合わせた出力のアスペクト比です。横長には 16:9、縦型 SNS 動画には 9:16、正方形には 1:1 を使用します。レイアウトを安定させるため、明示的に指定してください。

**選択肢:** `16:9`, `9:16`, `1:1`

---

`language`   `enum<string>`   **任意**

台詞とナレーションの言語です。英語は `en`、中国語は `zh` を指定します。プロンプトに複数の言語が混在する場合は、明示的に指定してください。

**選択肢:** `en`, `zh`

## レスポンス

リクエストが成功すると、HTTP `201` が返されます。

```json
{
  "data": {
    "id": "task_p9Lm2",
    "object": "task",
    "task_kind": "workflow",
    "capability_id": "ecommerce-video",
    "capability_version": 1,
    "workflow": "ecommerce-video",
    "status": "queued",
    "stage": "queued",
    "created_at": 1782210000,
    "updated_at": 1782210000,
    "completed_at": null,
    "output": null,
    "usage": {
      "credits_reserved": 4.5,
      "credits_charged": 4.5,
      "billable_duration_seconds": 15,
      "credits_settled": 0,
      "credits_refunded": 0
    },
    "request_id": "req_def456",
    "error_code": null,
    "error_message": null
  }
}
```

## 次の手順

受付レスポンスの `data.id` を保存し、`status` が `succeeded` または `failed` になるまで、5～10 秒ごとに `GET /v1/tasks/{task_id}` をポーリングします。完成した素材は `data.output.media` から取得します。

## エラー

| ステータスコード | 意味と対処方法                                                                                                                                                                                                     |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `400`    | JSON の形式が不正、またはフィールド・値・組み合わせが未対応です（`bad_request`。メッセージにフィールド名が記載されます）。入力がコンテンツ審査で拒否された場合は `content_policy_violation` です。修正せずに再試行しても成功しません。                                                                  |
| `401`    | API キーが未指定（`missing_api_key`）、またはキーが不正・期限切れ・無効・上限到達です（`invalid_api_key`。理由はメッセージに記載されます）。`Authorization: Bearer <key>` で送信してください。`sk-` 接頭辞の有無にかかわらず使えます。そのまま再試行しないでください。                                    |
| `402`    | 残高不足です（`insufficient_credits`）。残高がゼロ、またはこのリクエストの料金に足りません。残高をチャージしてから再度送信してください。それまでは再試行しないでください。                                                                                                            |
| `403`    | キーまたはアカウントに、この呼び出しの権限がありません（`forbidden`）。例として、無料クレジットでは利用できないモデル（チャージすると利用可能）、キーの IP 許可リスト外からのリクエスト、キーのグループに含まれないモデルがあります。そのまま再試行しないでください。                                                                  |
| `409`    | `Idempotency-Key` が別のリクエストボディで使用済み、または同じキーの最初のリクエストが処理中です（`idempotency_conflict`）。そのまま再試行しないでください。                                                                                                          |
| `429`    | 同時処理中のタスクが多すぎます（`user_concurrency_exceeded`）、またはリクエスト数が上限を超えています（`rate_limit_exceeded`）。処理中のタスクが完了した後、または `Retry-After` の秒数だけ待った後に再試行できます。                                                                  |
| `500`    | 予期しない内部エラーです（`internal_error`）。再試行できます。繰り返し発生する場合は、`request_id` を控えてサポートに連絡してください。                                                                                                                          |
| `503`    | リクエストを完了できませんでした（`processing_unavailable`、`processing_timeout`、`processing_failed`、`result_transfer_failed`）。課金されていません。待機時間を段階的に延ばして再試行できます。待機時間が判明している場合は `Retry-After` が返されます。BeatAPI は 502 や 504 を返しません。 |