How to use Sound effects?
Case 1 When using text-to-video, image-to-video, or transition generation
1. Add fields below to generate background music
| Field Name | Description | Type | Required | Accepted Values | Notes |
|---|---|---|---|---|---|
sound_effect_switch | Enable background music | boolean | No | true, false | Controls whether to generate background music. Must be a boolean. |
sound_effect_content | Sound effect content | string | No | - | Optional. If not provided, a random sound effect will be generated. |
2. Introduction by use case
| Using Template | sound_effect_switch | sound_effect_content | Expected Result | Credits Charged |
|---|---|---|---|---|
| Yes | true | Not provided | Uses background music from the template | Video generation only (e.g., 45 credits) |
| Yes | true | "" (empty string) | Auto-generates sound if template has none | Video generation only (e.g., 45 credits) |
| Yes | true | "sea waves" | Overrides template music with given content | Video generation only (e.g., 45 credits) |
| Yes | false | Any | No background music | Video generation only (e.g., 45 credits) |
| No | true | Not provided | Auto-generates sound based on video content | 45 (video) + 10 (sound_effect) = 55 credits |
| No | true | "" (empty string) | Same as above | 45 (video) + 10 (sound_effect) = 55 credits |
| No | true | "sea waves" | Generates sound based on provided content | 45 (video) + 10 (sound_effect) = 55 credits |
| No | false | Any | No background music | Video generation only (e.g., 45 credits) |
Case 2 Sound Effects endpoint
1. Request Curl
2. fields needed
| Field Name | Description | Type | Required | Accepted Values | Note |
|---|---|---|---|---|---|
source_video_id | ID of the generated video | int | Yes | - | Required if video_media_id is not provided |
video_media_id | ID of the uploaded video | int | Yes | - | Required if source_video_id is not provided |
model | Model | string | No | - | Currently not required; reserved for future use |
original_sound_switch | OriginalSoundSwitch | boolean | No | true, false | Default is false. Set to true to keep original video audio |
sound_effect_content | SoundEffectContent | string | No | Any string or leave empty | Optional. If not provided, a random sound effect will be generated |
Sound Effect Billing
| Function | Billing Standard | Example Usage |
|---|---|---|
| Sound effect | 10 Credits every 5 seconds | 5s → 10 Credits 8s → 20 Credits 10s → 20 Credits |