Skip to main content
POST
/
v1
/
audio
/
sfx-generation
Sound Effect Generation
curl --request POST \
  --url https://apis.finevoice.ai/v1/audio/sfx-generation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "Thunderstorm with heavy rain and distant thunder",
  "negative_prompt": "music, voices",
  "sourceUrl": "<string>",
  "sourceType": "video",
  "duration": 5,
  "useAsync": true
}
'
{
  "status": 123,
  "url": "<string>",
  "taskId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "urls": [
    "<string>"
  ],
  "service": "<string>",
  "port": "<string>",
  "timestamp": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token (API key). Format: Bearer {your_api_key}

Body

application/json

The sound effect generation request payload.

​
prompt
string

The prompt describing the desired sound effect.

Example:

"Thunderstorm with heavy rain and distant thunder"

​
negative_prompt
string

The negative prompt describing sounds to avoid.

Example:

"music, voices"

​
sourceUrl
string

Source video or image URL for generating contextual sound effects. If provided, sourceType is required.

​
sourceType
string

The source media type. Supported: image, video. Required when sourceUrl is provided.

Example:

"video"

​
duration
number<float>

Requested output duration in seconds. Maximum is 30 seconds.

Example:

5

​
useAsync
boolean

Set to true to process asynchronously.

Example:

true

Response

Task accepted. Returns a taskId for async polling or the result URL directly.

Standard response for audio processing tasks.

​
status
integer<int32>

HTTP-style status code (200 for success, 202 for in-progress).

​
url
string

Download URL of the generated audio file (available when completed).

​
taskId
string

Task identifier for async polling. Use with GET /v1/task/{task_id}.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
error
object
​
urls
string[]

Multiple output URLs (e.g. for separation stems).

​
service
string
​
port
string
​
timestamp
string