Skip to main content
POST
Generate sound effect with Sonilo Video SFX

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
video
string
required

The input video (MP4/WebM, up to 360 seconds, 30 MB remote-fetch cap). A public video URL, an uploaded-file URL from POST /v1/uploads, a data URI, or raw base64. Its duration is measured server-side and is the billing basis.

format
enum<string>
default:mp3

Output audio format of the SFX track.

Available options:
mp3,
wav
prompt
string

Optional direction for the sound design (up to 1000 characters), e.g. "realistic Foley and ambience, no music".

Response

Job accepted.

id
string

Opaque job id — use it to poll status.

Example:

"aud_a1b2c3d4e5f6"

message
string
model
string
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout