本文へスキップ

Video Sound Effects API

spicyapi/foley-v1/video-to-audio

Video Sound Effects は、クリップを見て画面の動きに合う効果音と環境音を生成し、新しいトラック付きの同じ動画として返します。音は 1〜30 秒で、セリフや音楽向けではありません。

最低価格 $0.0012/秒

プレイグラウンド

リクエストを送信

クイックスタート

例は、選択中のエンドポイントの公開パラメーター定義から作っています。API キーとサンプル素材を差し替えて、ご自身のサーバーから送信してください。

SDK・連携
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

API 認証

API キーはサーバーの環境変数 SPICY_API_KEY に保存します。Bearer 認証を使用し、JSON リクエストには Content-Type: application/json を指定してください。

Authorization: Bearer $SPICY_API_KEY
# Generate the idempotency key once; reuse it when retrying after a lost response.
export SPICY_IDEMPOTENCY_KEY="${SPICY_IDEMPOTENCY_KEY:-$(uuidgen)}"
curl -X POST https://api.spicyapi.ai/api/v1/jobs/createTask \
  -H "Authorization: Bearer $SPICY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SPICY_IDEMPOTENCY_KEY" \
  -d '{
  "model": "spicyapi/foley-v1/video-to-audio",
  "input": {
    "duration_seconds": 8,
    "video_url": "https://example.com/reference.mp4"
  }
}'

# Copy data.taskId from the response into TASK_ID, then poll the status.
TASK_ID="TASK_ID_FROM_RESPONSE"
curl "https://api.spicyapi.ai/api/v1/jobs/recordInfo?taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

このモデルの入力スキーマから生成した例です。API はどのリクエストも、同じスキーマで検証します。

入力パラメーター

これらのフィールドは、リクエスト本文の input オブジェクトに指定します。名前と型は API と一致します。デフォルト値の指定がない項目に、デフォルト値があると想定しないでください。

video_urlstring必須

音を付けるクリップ。映像はそのまま使われます。MP4 ファイルそのものへの直リンクが必要で、アップロードが最も確実です。

デフォルト値
指定なし
制約
minLength:1
contentMediaType:["video/mp4","video/webm","video/quicktime"]
stepsinteger任意

仕上げの反復回数、4〜50。増やすと時間がかかります。既定値がちょうどよいバランスです。

デフォルト値
25
制約
minimum:4
maximum:50
guidance_scalenumber任意

音が説明にどれだけ忠実に従うか、0〜20。ほとんどのクリップは既定値で十分です。プロンプトが無視されるようなら少し上げてください。

デフォルト値
4.5
制約
minimum:0
maximum:20
ignore_visual_semanticsboolean任意

既定ではオフで、モデルは映像の内容とプロンプトの両方から鳴らす音を決めます。画面に映っていない音や、映像からは読み取れない雰囲気など、プロンプトだけで音を決めたいときはオンにしてください。タイミングは引き続きクリップ内の動きに合わせます。料金は変わりません。

デフォルト値
false
negative_promptstring任意

入れたくない音。音楽、話し声、風の雑音など。

デフォルト値
指定なし
制約
maxLength:1000
duration_secondsinteger任意料金に影響

生成する音の秒数、1〜30。返ってくる動画はこの長さで切られ、クリップのほうが短くてもこの秒数ぶん課金されるので、クリップの長さに合わせてください。

デフォルト値
8
制約
minimum:1
maximum:30
promptstring任意

欲しい音を短く並べてください。窓に当たる雨、遠くの車の音、砂利を踏む足音など。省略すると、画面の動きに合った音を求める汎用の説明が代わりに送られます。

デフォルト値
指定なし
制約
minLength:1
maxLength:1000

タスクを追跡

HTTP 202 はタスクを受け付けたという意味で、生成が終わったという意味ではありません。返ってきた taskId を保存し、そのタスクの状態を問い合わせてください。結果を待っている間に、同じ内容でタスクを作り直さないでください。

受理レスポンス
HTTP/1.1 202 Accepted
Location: /api/v1/jobs/recordInfo?taskId=job_01k3m8x9q2z4v7n5p6r8s0t1w3

{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_create",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "state": "queued",
    "estimatedCost": "0.750000"
  }
}

受理レスポンスには今回の概算料金が含まれるため、アプリのタスク履歴と請求画面に同じ金額を表示できます。

タスクを取得する
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

ポーリングは約 2 秒間隔から始め、徐々に間隔を延ばします。終了状態になったら止めてください。通信が切れたときも、元の taskId で状態を確認します。作成をやり直すときは、同じ冪等キーと同じ本文をそのまま使い回してください。

あるいは、コールバックに知らせてもらう
import { verifyWebhook } from "@spicyapi/sdk";

// express.raw keeps the bytes we signed; express.json never matches.
app.post("/hooks/spicy", express.raw({ type: "application/json" }), (req, res) => {
  const { payload } = verifyWebhook({
    rawBody: req.body,
    timestamp: req.header("X-Webhook-Timestamp"),
    signature: req.header("X-Webhook-Signature"),
    payloadVersion: Number(req.header("X-Webhook-Payload-Version")),
    secret: process.env.SPICY_WEBHOOK_SECRET,
  });
  res.status(200).end();
  void handleFinishedTask(payload);
});

タスク作成時に callBackUrl を渡せば、完了したレコードが POST で届きます——ポーリングは一切不要です。配信には毎回 X-Webhook-Timestamp、X-Webhook-Signature、X-Webhook-Payload-Version が付きます。署名は taskId.timestamp.sha256(body) に対する HMAC-SHA256(base64)なので、生のバイト列で検証してください。JSON を解析して再度文字列化するとバイト列が変わり、検証は必ず失敗します。失敗した配信は再送されるため同じ taskId が二度届くことがあります。ハンドラーは冪等に。まず 2xx を返し、処理はその後で——応答が遅いと配信失敗として扱われます。

結果を取得

output を読むのは、state が succeeded のときだけにしてください。失敗したときは errorCode、errorMessage、request_id を手がかりに調べます。例に出ている料金や状態は、実際の請求ではありません。

完了レスポンスの例
{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_record",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "model": "spicyapi/foley-v1/video-to-audio",
    "state": "succeeded",
    "output": {
      "assets": [
        {
          "key": "tasks/2026/08/28/job_01k3m8x9q2z4v7n5p6r8s0t1w3/3f7a1c9e5b2d48f0a6c1e3d5b7f9a1c3.mp4",
          "mime": "video/mp4",
          "url": "https://example.r2.cloudflarestorage.com/results/job_01k3m8x9q2z4v7n5p6r8s0t1w3/result.mp4?X-Amz-Signature=SIGNATURE_FROM_RESPONSE",
          "expiresAt": "2026-08-28T12:20:08.000Z"
        }
      ]
    },
    "cost": "0.750000",
    "settled": true,
    "createdAt": "2026-08-28T12:00:00Z",
    "completedAt": "2026-08-28T12:00:30Z"
  }
}

利用可能なファイルは assets[].url からそのまま開くか、ダウンロードできます。API の Authorization ヘッダーは不要です。署名付き URL は expiresAt で失効しますが、保存期間内であればタスクを再取得することで更新できます。処理中または利用できないファイルに URL はありません。署名付き URL は非公開情報として扱ってください。

SDK・連携

アプリ、ターミナル、AI アシスタント、ビジュアルワークフローで SpicyAPI を活用。接続ガイドを選んでください。

ComfyUI で使う

ComfyUI Manager か下のコマンドで SpicyAPI ノードをインストールしたら、キャンバスで Video Sound Effects · Add Sound Effects を検索してください。このノードにはこのページと同じオプションがあり、実行前に価格が表示されます。

cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi