Operation

Generate Sound Effects

Generate one-off SFX or context-aware SFX from an uploaded video clip.

Start Here Operations Reference

Open Console OpenAPI Spec

Operation: soundfx.generate

Submit via POST /api/v1/requests

Credits: dynamic

Request fields

prompttitlemodeduration_secondsvideo_urldescription_promptnegative_tagsprompt_influenceseed

Example request

{
  "operation": "soundfx.generate",
  "input": {
    "prompt": "Soft ceramic mug set down on an old wooden table with room tone intact.",
    "title": "Table Foley",
    "mode": "video_context",
    "duration_seconds": 8,
    "video_url": "https://example.com/scene.mp4"
  }
}

curl -X POST https://www.cannonstudio.app/api/v1/requests \
  -H "Content-Type: application/json" \
  -H "x-api-key: $CANNON_API_KEY" \
  -H "x-idempotency-key: soundfx-generate-001" \
  -d @- <<'JSON'
{
  "operation": "soundfx.generate",
  "input": {
    "prompt": "Soft ceramic mug set down on an old wooden table with room tone intact.",
    "title": "Table Foley",
    "mode": "video_context",
    "duration_seconds": 8,
    "video_url": "https://example.com/scene.mp4"
  }
}
JSON

Notes

Supports one-off SFX generation and video-context SFX generation.
Include `video_url` to use the context-aware SFX path.
When video context is used, the response may include both an extracted audio URL and an SFX preview video URL.

Success output

{
  "task_id": "sfx_123",
  "asset_type": "audio",
  "status": "succeeded",
  "audio_url": "https://storage.googleapis.com/.../sfx.mp3",
  "sfx_video_url": "https://storage.googleapis.com/.../sfx-preview.mp4",
  "provider": "replicate",
  "model": "soundfx",
  "mode": "video_context"
}