Sonilo DuckAudio
CertifiedDuck music under voice
Sonilo DuckAudio
Duck music under voice
Submits POST /v1/audio-ducking, polls GET /v1/tasks/{task_id}, and stores the mix in Kestra internal storage. Provide exactly one voice source and exactly one music source. A voice video is returned as a video mix. Killing the task stops the local wait only. Sonilo has no cancel endpoint, so remote work can continue and can still be billed.
type: io.kestra.plugin.sonilo.DuckAudioExamples
Duck background music under a voice track
id: duck_voice_and_music
namespace: company.media
inputs:
- id: voice_uri
type: FILE
- id: music_uri
type: FILE
tasks:
- id: duck_audio
type: io.kestra.plugin.sonilo.DuckAudio
apiToken: "{{ secret('SONILO_API_TOKEN') }}"
voice: "{{ inputs.voice_uri }}"
music: "{{ inputs.music_uri }}"
Properties
apiToken *string
Sonilo API token
Bearer token from a Sonilo Platform account at platform.sonilo.com. Platform keys are separate from sonilo.com app logins. Sent as Authorization: Bearer.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
https://api.sonilo.comSonilo API base URL
API host root. Defaults to https://api.sonilo.com. A trailing slash, or a base that already ends in /v1, is accepted.
music string
Music from internal storage
Kestra URI of the background music. The music input must be audio. Set this or musicUrl, not both.
Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.
musicUrl string
Music URL
URL of the background music. Set this or music, not both.
options
HTTP client configuration
Optional proxy, timeout, and TLS settings for calls to the Sonilo API.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pollInterval string
PT3STime between Sonilo task status checks
Used after an async submission while waiting for GET /v1/tasks/{task_id}. Defaults to PT3S.
voice string
Voice from internal storage
Kestra URI of the foreground voice. Audio or video is accepted. Set this or voiceUrl, not both.
Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.
voiceUrl string
Voice URL
URL of the foreground voice. Set this or voice, not both.
waitTimeout string
PT30MMaximum time to wait for a Sonilo task
Async generation, including stem separation, is polled until this timeout. Defaults to PT30M. Stem separation often finishes in a few minutes and can run much longer.
Outputs
audioUri string
uriInternal storage URI of the ducked mix
contentType string
MIME type of the mix
outputType string
Ducking output container, audio or video
status string
Sonilo task status
taskId string
Sonilo task identifier
