tencent cloud

APIs

CreateProcedureTemplate

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-09-18 15:59:06

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to create user-defined task flow templates. Template capacity limit: 50.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateProcedureTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Name Yes String

Task flow name (supports Chinese, up to 20 characters).

SubAppId No Integer

Video-on-demand (VOD) application ID. For customers who activate VOD services on or after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).

Comment No String

Transcoding template description. Length limit: 256 characters.

MediaProcessTask No MediaProcessTaskInput

Video processing type task parameters.

AiContentReviewTask No AiContentReviewTaskInput

AI content review type task parameter .
: This parameter is used to initiate legacy review and is not recommended. It is recommended to use the ReviewAudioVideoTask parameter to initiate review.

AiAnalysisTask No AiAnalysisTaskInput

Parameters for the AI content analysis task.

AiRecognitionTaskSet.N No Array of AiRecognitionTaskInput

Parameters for the AI content recognition task.

ReviewAudioVideoTask No ProcedureReviewAudioVideoTaskInput

Parameters for the audio and video moderation task.

ImportMediaKnowledgeTaskSet.N No Array of ImportMediaKnowledgeTaskInput

Task parameter for importing Intelligent Media Assets knowledge base.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a Task Flow Template to Initiate Content Review Tasks

Create a task flow template named "My Task Flow" to initiate a content review task, including content involving offensive, unsafe, and inappropriate information. The content review template ID used is 10.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<Common request parameters>

{
    "AiContentReviewTask": {
        "Definition": 10
    },
    "Name": "My task flow"
}

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

Example2 Creating a Task Flow Template That Initiates a Watermarked Transcoding Task

Create a task flow template named "My Task Flow" to transfer 20, 30, and 40 formats, and add a watermark to each transferred video using the watermark template ID 15780.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<Common request parameters>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            },
            {
                "Definition": 20,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            },
            {
                "Definition": 40,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            }
        ]
    },
    "Name": "My task flow"
}

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

Example3 Creating a Task Flow Template for Initiating a Transcoding Task

Create a task flow template named "My Task Flow" with three formats: 20, 30, and 40.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<Common request parameters>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ]
    },
    "Name": "My task flow"
}

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

Example4 Create a task flow template for initiating transcoding and sampling screenshot tasks

Create a task flow template named "My Task Flow" to transfer 20, 30, and 40 formats. At the same time, take sampled screenshots of the video using the sampled screenshot template ID 10.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<Common request parameters>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ],
        "SampleSnapshotTaskSet": [
            {
                "Definition": 10
            }
        ]
    },
    "Name": "My task flow"
}

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.ExistedProcedureName Task flow template name already exists.
InvalidParameterValue.SubAppId Parameter value error: app ID.
LimitExceeded The quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백