Help Center/ Video On Demand/ API Reference/ Media Asset Processing/ Extracting Audio
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Extracting Audio

Function

This API is an asynchronous API. After an audio extraction task is created and delivered, a media asset ID (asset_id) and an extracted audio ID (audio_asset_id) are returned. However, the audio extraction task is not complete immediately. You can check whether the task is complete based on the audio extraction completion event on the event notification page.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1.0/{project_id}/asset/extract_audio

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

asset_id

Yes

String

Media asset ID assigned by VOD. It can only be queried but cannot be modified.

parameter

No

Parameter object

Parameters of the audio to be extracted.
Table 4 Parameter

Parameter

Mandatory

Type

Description

format

No

String

Packaging format.

The options include:

  • MP3

  • AAC

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

asset_id

String

Media ID of the source video.

audio_asset_id

String

Media ID of the extracted audio.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example extracts an audio file.

POST https://{endpoint}/v1.0/{project_id}/asset/extract_audio

Content-Type: application/json
{
  "asset_id": "3e1cd21131a94525be55acf65888bf46",
  "parameter": {
    "format": "MP3"
  }
}

Example Responses

Status code: 202

Returned when the request succeeded.

{
  "asset_id" : "f488337c31c8e4622f1590735b134c65",
  "audio_asset_id" : "5412"
}

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

Status Codes

Status Code

Description

202

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Media Asset Processing