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

HappyHorse 1.0

POST https://api.beatapi.io/v1/videos/tasks

写真から 3~15 秒の動画を生成します。720p・1080p に対応しています。画像の入力は必須です。

対応する生成モード

モード必須の入力入力ルール
画像から動画を生成model, prompt, images画像は必須です。このモデルでは、テキストのみから動画を生成するモードは提供されていません。
複数の元画像を使用model, prompt, images同じ被写体を異なる角度から撮影した画像を、最大 9 枚指定できます。

非同期処理の流れ: タスクを作成して data.id を保存し、GET /v1/tasks/{task_id} でステータスをポーリングします。succeeded の場合は data.output.media から結果を取得します。failed の場合は data.error_code と data.error_message を確認し、エラーと再試行の方針に従って対処してください。

ローカルファイルを使う場合: 先に入力ファイルをアップロードし、返された data.url を指定してください。

認証

Authorization   string   必須

BeatAPI の API キーを Bearer トークンとして送信します。API キーはダッシュボードで作成できます。

Authorization: Bearer <BEATAPI_API_KEY>

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

リクエストボディ

model   string   必須

happyhorse-1.0 を指定してください。

固定値: happyhorse-1.0


prompt   string   必須

ショット内の動き、表情、カメラワークなどを指定します。

文字数: 1 – 5000 文字


images   string[]   必須

元画像を公開 HTTPS URL で指定します。少なくとも 1 枚が必要です。

要素数: 1 – 9 件


duration   integer   任意

出力動画の長さを秒単位で指定します。

デフォルト値: 5
範囲: 3 – 15


aspect_ratio   enum<string>   任意

出力動画のアスペクト比です。

選択肢: 16:9, 9:16, 1:1, 4:3, 3:4
デフォルト値: "16:9"


resolution   enum<string>   任意

出力解像度の区分です。選択した解像度によって料金が変わります。

選択肢: 720p, 1080p
デフォルト値: "720p"

リクエスト例

画像から動画を生成

curl --request POST \
--url https://api.beatapi.io/v1/videos/tasks \
--header 'Authorization: Bearer <BEATAPI_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"model": "happyhorse-1.0",
"prompt": "The woman turns toward the camera and smiles, hair moving in the breeze.",
"images": [
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 5,
"aspect_ratio": "9:16",
"resolution": "720p"
}'

複数の元画像を使用

curl --request POST \
--url https://api.beatapi.io/v1/videos/tasks \
--header 'Authorization: Bearer <BEATAPI_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"model": "happyhorse-1.0",
"prompt": "Hold the product exactly as photographed while the camera pushes in.",
"images": [
"https://media.beatapi.io/samples/smart-bottle.png",
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 10,
"aspect_ratio": "16:9",
"resolution": "1080p"
}'

レスポンス

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

{
"data": {
"id": "task_8K2qA",
"object": "task",
"task_kind": "video",
"capability_id": "happyhorse-1.0",
"capability_version": null,
"media_type": "video",
"model": "happyhorse-1.0",
"status": "queued",
"stage": "queued",
"created_at": 1782210000,
"updated_at": 1782210000,
"completed_at": null,
"output": null,
"usage": {
"credits_reserved": 0.7,
"credits_charged": 0.7,
"billable_duration_seconds": 5,
"credits_settled": 0,
"credits_refunded": 0
},
"request_id": "req_abc123",
"error_code": null,
"error_message": null
}
}

エラー

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