tencent cloud

APIs

CreateProcedureTemplate

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-05-19 15:00:33

1. API Description

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

This API is used to create a custom task flow template. Up to 50 templates can be created.

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 (support Chinese, up to 20 characters).
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Comment No String Template description, with a length limit of 256 characters.
MediaProcessTask No MediaProcessTaskInput Parameters for the video processing type task.
AiContentReviewTask No AiContentReviewTaskInput Parameters for the AI content review task.
*: This parameter is used for legacy review initiation, 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.

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 Trigger Content Review Tasks

Create a task flow template named "My Task Flow" to trigger a content review task (involving offensive content, unsafe information, and inappropriate information) with the content review 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>

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

Output Example

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

Example2 Create a task flow template to initiate a watermarked transcoding task

Create a task flow template named "My Task Flow", transfer 20, 30, and 40 three formats, and add a watermark to each video with 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.0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0.0
                    }
                ]
            },
            {
                "Definition": 20,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0.0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0.0
                    }
                ]
            },
            {
                "Definition": 40,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0.0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0.0
                    }
                ]
            }
        ]
    },
    "Name": "My task flow"
}

Output Example

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

Example3 Creating a Task Flow Template to Initiate a Transcoding Task

Create a task flow template named "My Task Flow" with task flow transcoding in 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 to initiate transcoding and sampling screenshot tasks

Create a task flow template named "My Task Flow" to transfer three formats (20, 30, 40), with simultaneous sampling screenshot taking for the video using 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 The task flow template name already exists.
InvalidParameterValue.SubAppId Incorrect parameter value: application id.
LimitExceeded Quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック