Video to Audio

Create Task

POST/v1/audio/video-to-audio

curl --request POST \
  --url https://api-singapore.klingai.com/v1/audio/video-to-audio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "video_url": "https://p1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/20fps-7s.mov",
    "external_task_id": "",
    "callback_url": ""
  }'

200

{
  "code": 0, // Error codes; Specific definitions can be found in "Error Code"
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
  "data": {
    "task_id": "string", // Task ID, generated by the system
    "task_info": { // Task creation parameters
      "external_task_id": "string" // Customer-defined task ID
    },
    "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
    "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
    "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
  }
}

Request Header

Content-TypestringRequiredDefault to application/json

Data Exchange Format

AuthorizationstringRequired

Authentication information, refer to API authentication

Request Body

video_idstringOptional

The ID of the video generated by the Kling AI

Either the video_id parameter or the video_url parameter, cannot be empty or have a value at the same time.

Only supports videos generated within 30 days and with a duration between 3.0s and 20.0s.

video_urlstringOptional

Link for uploaded video

Either the video_id parameter or the video_url parameter, cannot be empty or have a value at the same time.

Only .mp4/.mov formats are supported. File size does not exceed 100MB. Video duration between 3.0s and 20.0s.

sound_effect_promptstringOptional

Sound effect prompt

Cannot exceed 200 characters

bgm_promptstringOptional

BGM prompt

Cannot exceed 200 characters

asmr_modebooleanOptionalDefault to false

Enable ASMR mode; This mode enhances detailed sound effects and is suitable for highly immersive content scenarios

true means enabled, false means disabled (default)

external_task_idstringOptional

Customized Task ID

Users can provide a customized task ID, which will not overwrite the system-generated task ID but can be used for task queries.

Please note that the customized task ID must be unique within a single user account.

callback_urlstringOptional

The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes

The specific message schema of the notification can be found in Callback Protocol

cURL
curl --request POST \
  --url https://api-singapore.klingai.com/v1/audio/video-to-audio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "video_url": "https://p1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/20fps-7s.mov",
    "external_task_id": "",
    "callback_url": ""
  }'
200
{
  "code": 0, // Error codes; Specific definitions can be found in "Error Code"
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
  "data": {
    "task_id": "string", // Task ID, generated by the system
    "task_info": { // Task creation parameters
      "external_task_id": "string" // Customer-defined task ID
    },
    "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
    "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
    "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
  }
}

Query Task (Single)

GET/v1/audio/video-to-audio/{id}

curl --request GET \
  --url https://api-singapore.klingai.com/v1/audio/video-to-audio/{task_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 0, // Error codes; Specific definitions can be found in "Error Code"
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
  "data": {
    "task_id": "string", // Task ID, generated by the system
    "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
    "task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
    "task_info": { // Task creation parameters
      "external_task_id": "string", // Customer-defined task ID
      "parent_video": { // Original video information
        "id": "string", // Original video ID
        "url": "string", // Original video URL
        "duration": "string" // Original video duration, unit: s (seconds)
      }
    },
    "task_result": {
      "videos": [
        {
          "id": "string", // Generated video ID; globally unique
          "url": "string", // URL for generating videos (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
          "duration": "string" // Total video duration, unit: s (seconds)
        }
      ],
      "audios": [
        {
          "id": "string", // Generated audio ID; globally unique, will be cleared after 30 days
          "url_mp3": "string", // URL for generating audio in MP3 format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
          "url_wav": "string", // URL for generating audio in WAV format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
          "duration_mp3": "string", // Total MP3 audio duration, unit: s (seconds)
          "duration_wav": "string" // Total WAV audio duration, unit: s (seconds)
        }
      ]
    },
    "final_unit_deduction": "string", // The deduction units of task
    "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
    "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
  }
}

Request Header

Content-TypestringRequiredDefault to application/json

Data Exchange Format

AuthorizationstringRequired

Authentication information, refer to API authentication

Path Parameters

task_idstringOptional

The task ID for audio generation

Request path parameter, fill the value directly in the request path

You can choose to query by external_task_id or task_id

external_task_idstringOptional

Customized Task ID for audio generation

The external_task_id filled in when creating the task. You can choose to query by external_task_id or task_id

cURL
curl --request GET \
  --url https://api-singapore.klingai.com/v1/audio/video-to-audio/{task_id} \
  --header 'Authorization: Bearer <token>'
200
{
  "code": 0, // Error codes; Specific definitions can be found in "Error Code"
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
  "data": {
    "task_id": "string", // Task ID, generated by the system
    "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
    "task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
    "task_info": { // Task creation parameters
      "external_task_id": "string", // Customer-defined task ID
      "parent_video": { // Original video information
        "id": "string", // Original video ID
        "url": "string", // Original video URL
        "duration": "string" // Original video duration, unit: s (seconds)
      }
    },
    "task_result": {
      "videos": [
        {
          "id": "string", // Generated video ID; globally unique
          "url": "string", // URL for generating videos (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
          "duration": "string" // Total video duration, unit: s (seconds)
        }
      ],
      "audios": [
        {
          "id": "string", // Generated audio ID; globally unique, will be cleared after 30 days
          "url_mp3": "string", // URL for generating audio in MP3 format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
          "url_wav": "string", // URL for generating audio in WAV format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
          "duration_mp3": "string", // Total MP3 audio duration, unit: s (seconds)
          "duration_wav": "string" // Total WAV audio duration, unit: s (seconds)
        }
      ]
    },
    "final_unit_deduction": "string", // The deduction units of task
    "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
    "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
  }
}

Query Task (List)

GET/v1/audio/video-to-audio

curl --request GET \
  --url 'https://api-singapore.klingai.com/v1/audio/video-to-audio?pageNum=1&pageSize=30' \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 0, // Error codes; Specific definitions can be found in Error codes
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, to track requests and troubleshoot problems
  "data": [
    {
      "task_id": "string", // Task ID, generated by the system
      "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
      "task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
      "task_info": { // Task creation parameters
        "external_task_id": "string", // Customer-defined task ID
        "parent_video": { // Original video information
          "id": "string", // Original video ID
          "url": "string", // Original video URL
          "duration": "string" // Original video duration, unit: s (seconds)
        }
      },
      "task_result": {
        "videos": [
          {
            "id": "string", // Generated video ID; globally unique
            "url": "string", // URL for generating videos (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
            "duration": "string" // Total video duration, unit: s (seconds)
          }
        ],
        "audios": [
          {
            "id": "string", // Generated audio ID; globally unique, will be cleared after 30 days
            "url_mp3": "string", // URL for generating audio in MP3 format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
            "url_wav": "string", // URL for generating audio in WAV format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
            "duration_mp3": "string", // Total MP3 audio duration, unit: s (seconds)
            "duration_wav": "string" // Total WAV audio duration, unit: s (seconds)
          }
        ]
      },
      "final_unit_deduction": "string", // The deduction units of task
      "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
      "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
    }
  ]
}

Request Header

Content-TypestringRequiredDefault to application/json

Data Exchange Format

AuthorizationstringRequired

Authentication information, refer to API authentication

Query Parameters

pageNumintOptionalDefault to 1

Page number

Value range: [1, 1000]

pageSizeintOptionalDefault to 30

Number of items per page

Value range: [1, 500]

cURL
curl --request GET \
  --url 'https://api-singapore.klingai.com/v1/audio/video-to-audio?pageNum=1&pageSize=30' \
  --header 'Authorization: Bearer <token>'
200
{
  "code": 0, // Error codes; Specific definitions can be found in Error codes
  "message": "string", // Error information
  "request_id": "string", // Request ID, generated by the system, to track requests and troubleshoot problems
  "data": [
    {
      "task_id": "string", // Task ID, generated by the system
      "task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
      "task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
      "task_info": { // Task creation parameters
        "external_task_id": "string", // Customer-defined task ID
        "parent_video": { // Original video information
          "id": "string", // Original video ID
          "url": "string", // Original video URL
          "duration": "string" // Original video duration, unit: s (seconds)
        }
      },
      "task_result": {
        "videos": [
          {
            "id": "string", // Generated video ID; globally unique
            "url": "string", // URL for generating videos (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
            "duration": "string" // Total video duration, unit: s (seconds)
          }
        ],
        "audios": [
          {
            "id": "string", // Generated audio ID; globally unique, will be cleared after 30 days
            "url_mp3": "string", // URL for generating audio in MP3 format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
            "url_wav": "string", // URL for generating audio in WAV format (To ensure information security, generated audio will be cleared after 30 days. Please make sure to save them promptly.)
            "duration_mp3": "string", // Total MP3 audio duration, unit: s (seconds)
            "duration_wav": "string" // Total WAV audio duration, unit: s (seconds)
          }
        ]
      },
      "final_unit_deduction": "string", // The deduction units of task
      "created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
      "updated_at": 1722769557708 // Task update time, Unix timestamp, unit: ms
    }
  ]
}