Help Center/ Video On Demand/ API Reference/ Media Asset Processing/ Processing Media Assets
Updated on 2026-01-16 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Processing Media Assets

Function

This API is used to transcode, capture snapshots of, or encrypt a video. You can start one or multiple operations at a time.

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/process

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.

template_group_name

No

String

Transcoding template group name.

NOTE:
If this parameter is specified, the specified transcoding template is used to transcode the uploaded audio/video. You can configure a transcoding template on the VOD console. For details, see "Transcoding Settings" in the VOD User Guide.

auto_encrypt

No

Integer

Whether to automatically encrypt a file.

The options include:

  • 0: not encrypted

  • 1: encrypted

Default value: 0

Encryption and transcoding must be performed at the same time. If encryption is required, the transcoding parameters cannot be empty, and the transcoding output format must be HLS.

thumbnail

No

Thumbnail object

Snapshot parameters.

Note: You will be billed for the snapshots generated. To avoid snapshot costs, you can leave these parameters unspecified.

subtitle_id

No

Array of integers

Subtitle file ID.

NOTE:

  • This parameter takes effect only when the APIs for Uploading a Media Asset to VOD and Updating a Video are called and the request parameter subtitles is specified.

  • If this parameter is not specified, the most recently uploaded subtitle is embedded into the video stream by default.

  • Subtitle files in a video stream can only be SRT.
Table 4 Thumbnail

Parameter

Mandatory

Type

Description

type

Yes

String

Snapshot capturing mode.

The options include:

  • time: Snapshots are captured by interval.

  • dots: Snapshots are captured at a specified time point.

  • quantity: Snapshots are captured based on the specified quantity and video duration.

quantity

No

Integer

This parameter is mandatory when type is set to quantity. Snapshots are captured based on the specified quantity and video duration.

Value range: an integer ranging from 1 to 10

quantity_time

No

Integer

This parameter is optional when type is set to quantity. Snapshots are captured based on the specified quantity at a specified interval.

Value range: an integer ranging from 0 to 2147483647

time

No

Integer

Interval at which snapshots are captured. Unit: seconds

This parameter is available when type is set to time.

Default value: 12

Value range: an integer ranging from 0 to 100

dots

No

Array of integers

This parameter is mandatory when type is set to dots. Array of time points when snapshots are captured.

cover_position

No

Integer

The value indicates which snapshot is specified as the thumbnail.

Default value: 1

format

No

Integer

Snapshot file format.

The options include:

  • 1: jpg

Default value: 1

aspect_ratio

No

Integer

Aspect ratio.

The options include:

  • 0: adaptive (the original aspect ratio is retained)

  • 1: 16:9

Default value: 0

max_length

No

Integer

The longest side of a snapshot.

Unit: pixel

The width of the snapshot is scaled proportionally with the longest side and input video pixel.

Default value: 480

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

asset_id

String

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

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example transcodes a media file.

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

Content-Type: application/json
{
  "asset_id": "b4f39691d66cc0ef75d62ee567146e11",
  "template_group_name": "test",
  "auto_encrypt": 0,
  "thumbnail": {
    "type": "time",
    "time": 12
  },
  "subtitle_id": [
    1
  ]
}

Example Responses

Status code: 202

Returned when the request succeeded.

{
  "asset_id" : "b4f39691d66cc0ef75d62ee567146e11"
}

Status code: 403

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.

403

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Media Asset Processing