API で任せる
写真をアップロードして任せ、終わったら結果のファイルを受け取ります。
API で任せた仕事も、画面で任せた仕事と同じようにプロジェクトとして残り、同じ残高から差し引かれます。
-
キーを作る
ログインしたあと、左のメニューの「API キー」で作ります。キーは、ワークスペースごとに一人一つです。
すべてのリクエストは、
Authorization: Bearerヘッダーでキーを送ります。以下のコードは、キーと URL をこの2行から読み込みます。export FLOW_API_KEY="<api_key>" export FLOW_URL="https://flow.unblanq.com" -
写真をアップロードする
写真1枚ごとに1回呼び出します。
slotはproduct_imagesにし、レスポンスのdescriptorを集めておきます。PNG・JPEG・WebP 形式を、1件につき 6枚まで受け付けます。アップロードした写真は、
descriptorのexpires_atまで保管されます。curl -X POST \ "$FLOW_URL/v1/agencies/agency%3Acommerce_shortcut/actions/run/uploads" \ -H "Authorization: Bearer $FLOW_API_KEY" \ -F "slot=product_images" \ -F "file=@<file>" -
任せる
集めた
descriptorをproduct_imagesに入れて送ります。idempotency_keyは、自分で決めてこのリクエストに付ける番号です。レスポンスの
result.run_idで状態を確認し、終わったらその状態のレスポンスから結果のファイルを受け取ります。同じ
idempotency_keyと同じinputsで24時間以内にもう一度送ると、新しく任せず、最初に任せたときのレスポンスをもう一度返します(deduplicated: true)。inputsが違うと、409で断ります。curl -X POST \ "$FLOW_URL/v1/agencies/agency%3Acommerce_shortcut/actions/run/runs" \ -H "Authorization: Bearer $FLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "product_images": [<descriptor>, <descriptor>], "min_length_seconds": "15", "max_length_seconds": "30", "language": "ja", "captions": "on" }, "idempotency_key": "request-001" }' -
状態を確認する
終わるまで数秒ごとに呼び出します。
statusがsucceeded・failed・cancelledのどれかになれば終わりです。failedなら、public_errorsに理由が入ります。curl "$FLOW_URL/v1/runs/<run_id>" \ -H "Authorization: Bearer $FLOW_API_KEY" -
結果を受け取る
succeededなら、状態のレスポンスのartifactsに結果のファイルが入ります。受け取る項目のdownload_urlを同じキーで呼び出すと、ファイルを受け取れます。# ファイルの受け取り:$FLOW_URL のあとに artifacts[] の download_url curl -L "$FLOW_URL<download_url>" \ -H "Authorization: Bearer $FLOW_API_KEY" \ -o <filename>
任せるときに入れるものrun
| 名前 | 形式 | 必須 | 説明 |
|---|---|---|---|
captions |
stringenum: "on", "off" |
いいえ | 字幕をオン(on)またはオフ(off)にします。送らない場合はオンです。 |
language |
stringenum: "ko", "en", "ja", "zh", "es", "pt", "fr", "de", "vi", "th", "id" |
いいえ | 動画の言語です。送らない場合は韓国語(ko)です。 |
logo_images |
arrayitems: object |
いいえ | ブランドロゴです。slot を logo_images にしてアップロードした descriptor を1つ入れます。 |
max_length_seconds |
stringenum: "5", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55", "60" |
はい | 動画の最長の長さ(秒)です。数値ではなく文字列で送ります。 |
min_length_seconds |
stringenum: "5", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55", "60" |
はい | 動画の最短の長さ(秒)です。数値ではなく文字列で送ります。 |
model |
object |
いいえ | 自動、またはモデルライブラリから、この動画で使用するモデルを選択します。selection_mode auto:商品と動画に合う新しい人物を自動で作成します。この人物はこの動画だけに使います。selection_mode load、record_id、revision_id:自分のモデルと、チーム・組織で共有されたモデルから直接選択します。 |
product_images |
arrayitems: object |
いいえ | 商品写真です。アップロードで受け取った descriptor を6つまで入れます。 |
product_source |
stringenum: "url", "upload" |
いいえ | 商品を何で渡すかを選びます。url なら product_url だけ、upload なら product_images だけを使います。送らない場合は upload です。 |
product_url |
string |
いいえ | 紹介する商品のページの URL です。product_source が url なら入れます。 |
project_id |
stringminLength: 1 |
はい | プロジェクトの番号です。 |
reference_source |
stringenum: "url", "upload" |
いいえ | 参考動画を何で渡すかを選びます。url なら reference_url だけ、upload なら reference_video だけを使います。送らない場合は url です。 |
reference_url |
string |
いいえ | 参考動画のURL。YouTube・Instagram・TikTok、Facebookのリール・広告ライブラリの広告、.mp4・.m4v動画ファイルの公開URLを入力できます。参考動画は1分以内のもののみ使用できます。動画内の音声やBGMには、別途著作権がある場合があります。これについてFlowは法的責任を負いません。 |
reference_video |
arrayitems: object |
いいえ | 参考動画のファイル。slot を reference_video にしてアップロードした descriptor を1つ入れます。参考動画は1分以内のもののみ使用できます。動画内の音声やBGMには、別途著作権がある場合があります。これについてFlowは法的責任を負いません。 |
request_id |
stringminLength: 1 |
はい | このリクエストの番号です。 |
project_id と request_id は送らなくてもかまいません。Flow が idempotency_key をもとに入れます。