Skip to main content

Video Sound Effects API

spicyapi/foley-v1/video-to-audio

Video Sound Effects watches a clip and generates effects and ambience that follow the action on screen, returned as the same video with the new track. Sound runs 1 to 30 seconds; it is not meant for dialogue or music.

From $0.0012/s
Run model

Workbench

Send a request

Quickstart

Examples use the selected endpoint’s public parameter definitions. Replace the API key and example media, then send the request from your server.

SDKs & integrations
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

API authentication

Keep the API key in the server environment variable SPICY_API_KEY. Use Bearer authentication and Content-Type: application/json for JSON requests.

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"

Generated from this model’s input schema — the same one the API validates every request against.

Input parameters

Place these fields inside the request body’s input object. Names and types match the API. Do not assume a default when none is specified.

video_urlstringRequired

The clip to add sound to. The picture is kept as it is. It must be a direct link to the MP4 file; uploading it is the most reliable route.

Default
Not specified
Constraints
minLength:1
contentMediaType:["video/mp4","video/webm","video/quicktime"]
stepsintegerOptional

Refinement passes, 4 to 50. More passes take longer; the default is a good balance.

Default
25
Constraints
minimum:4
maximum:50
guidance_scalenumberOptional

How closely the sound follows your description, 0 to 20. The default suits most clips; raise it a little if the result ignores the prompt.

Default
4.5
Constraints
minimum:0
maximum:20
ignore_visual_semanticsbooleanOptional

Off by default: the model decides what to play from both the picture and your prompt. Turn it on when the sound should come from the prompt alone, for example a sound that is not on screen or a mood the picture does not show; the timing still follows the motion in the clip. Does not change the price.

Default
false
negative_promptstringOptional

Sounds to keep out, such as music, speech or wind noise.

Default
Not specified
Constraints
maxLength:1000
duration_secondsintegerOptionalAffects price

How many seconds of sound to generate, 1 to 30. The returned video is cut to this length, and these seconds are billed even if the clip is shorter, so match it to your clip.

Default
8
Constraints
minimum:1
maximum:30
promptstringOptional

The sounds you want, as a short list: rain on a window, distant traffic, footsteps on gravel. Leave it out and a general request for sounds that match the on-screen action is sent instead.

Default
Not specified
Constraints
minLength:1
maxLength:1000

Track the task

HTTP 202 means the task was accepted, not completed. Save the returned taskId and query that task. Do not create another task while waiting for its result.

Accepted response
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"
  }
}

The accepted response includes the estimate so your app can show the same amount in task history and billing.

Read the job
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Start polling at about 2 seconds and gradually increase the interval. Stop at a terminal state. After a connection failure, query the original taskId. Retry creation only with the original idempotency key and body.

Or let the callback find you
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);
});

Pass callBackUrl when you create the task and the finished record is POSTed to you — no polling loop at all. Every delivery carries X-Webhook-Timestamp, X-Webhook-Signature and X-Webhook-Payload-Version. The signature is a base64 HMAC-SHA256 over taskId.timestamp.sha256(body), so it must be checked against the raw bytes: parsing the JSON and re-serialising it changes them and the check will fail. Failed deliveries are retried, so the same taskId can arrive twice — make the handler idempotent. Answer 2xx first and do the work afterwards; a slow handler is treated as a failed delivery.

Read the result

Consume output only when state is succeeded. On failure, use errorCode, errorMessage and request_id to investigate. Example costs and states do not represent an actual bill.

Completed response example
{
  "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"
  }
}

For each available asset, open or download assets[].url directly without an API Authorization header. The signed URL expires at expiresAt; poll the task again to refresh it while the asset remains within its retention period. A pending or unavailable asset has no URL. Treat signed URLs as private.

SDKs & integrations

Use SpicyAPI in your app, terminal, AI assistant or visual workflow. Choose a setup guide below.

SDKs
TypeScript · Python · Go · PHP · Java
CLI
Terminal commands and automation scripts.
MCP
Claude Code · Cursor · Codex
Agent Skill
Reusable instructions for your AI assistant.
n8n
Self-hosted community nodes and importable HTTP Request templates for n8n Cloud.
ComfyUI
Image, video and audio workflows on a node canvas.

More integrations

SillyTavernTelegram / DiscordApp proxyOpenAI SDKLangChainVercel AI SDK
Browse ready-to-use workflows

Use it in ComfyUI

Install the SpicyAPI nodes from ComfyUI Manager or with the command below, then search for Video Sound Effects · Add Sound Effects on the canvas. The node has the same options as this page and shows its price before it runs.

cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi
Workflow examplesSetup guideSource on GitHub