⌘K

Kirin Video to Audio

kirin_video_to_audio

Kirin Video to Audio is a Vtrix packaged audio generation model that creates sound effects and background music for an input video.

API Notes

kirin_video_to_audio is a Vtrix packaged model. The upstream audio tool does not require a model field; use kirin_video_to_audio only as the Vtrix model value.

Provide exactly one primary video input: video_url or video_id. They cannot both be empty, and they cannot both be provided.

Authentication

authorization string required

All APIs require authentication via Bearer Token.

Get API Key:

Visit API Key Management Page to get your API Key.

Usage:

Add to request header:

Authorization: Bearer YOUR_API_KEY

Parameters

model string required

Model ID to use for the request

Value: kirin_video_to_audio


video_url string

Public video URL used as the source for audio generation. video_url and video_id are mutually exclusive: one must be provided, and only one may be provided.

Supported formats: mp4, mov

Maximum file size: 100 MB

Video duration: 3.0 - 20.0 seconds


video_id string

Existing video task ID used as the source for audio generation. video_id and video_url are mutually exclusive: one must be provided, and only one may be provided.

Only supports Kling AI videos generated within the last 30 days with a duration of 3.0 - 20.0 seconds


sound_effect_prompt string

Optional prompt describing the desired sound effects

Maximum length: 200 characters


bgm_prompt string

Optional prompt describing the desired background music

Maximum length: 200 characters


asmr_mode boolean

Whether to enable ASMR mode. This mode enhances detailed sound effects and is suitable for highly immersive content scenarios.

true: Enable ASMR mode

false: Disable ASMR mode

Default: false


callback_url string

Callback notification address for task status changes. When configured, the server actively sends the task result notification.


external_task_id string

Custom task ID. Does not override the system-generated task ID but can be used to query the task.

Note: Must be unique per user.

Polling

Since result generation takes time, you need to poll the task status after creating the task.

The initial response only returns information such as the task ID and initial status. The final result must be obtained by polling the task status endpoint using the task ID.

See the examples on the right for polling requests and responses.