Help & DocumentationAPIsVideo on DemandParameter Template APIsCreateProcedureTemplate

CreateProcedureTemplate

Last updated: 2020-03-27 18:45:39

1. API Description

Domain name for API request: vod.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.

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 parameter. The value used for this API: CreateProcedureTemplate.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Name Yes String Task flow name (up to 20 characters).
MediaProcessTask No MediaProcessTaskInput Parameter of video processing task.
AiContentReviewTask No AiContentReviewTaskInput Parameter of AI-based content audit task.
AiAnalysisTask No AiAnalysisTaskInput Parameter of AI-based content analysis task.
AiRecognitionTask No AiRecognitionTaskInput Type parameter of AI-based content recognition task.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a task flow template that initiates a transcoding task

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into three formats of 20, 30, and 40.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateProcedureTemplate
&Name=My Task Flow
&MediaProcessTask.TranscodeTaskSet.0.Definition=20
&MediaProcessTask.TranscodeTaskSet.1.Definition=30
&MediaProcessTask.TranscodeTaskSet.2.Definition=40
&<Common request parameters>

Output Example

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

Example2 Creating a task flow template that initiates a transcoding task with watermark

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into three formats of 20, 30, and 40, where each output video has a watermark added by watermarking template ID 15780.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateProcedureTemplate
&Name=My Task Flow
&MediaProcessTask.TranscodeTaskSet.0.Definition=20
&MediaProcessTask.TranscodeTaskSet.0.Watermarks.0.Definition=15780
&MediaProcessTask.TranscodeTaskSet.1.Definition=30
&MediaProcessTask.TranscodeTaskSet.1.Watermarks.0.Definition=15780
&MediaProcessTask.TranscodeTaskSet.2.Definition=40
&MediaProcessTask.TranscodeTaskSet.2.Watermarks.0.Definition=15780
&<Common request parameters>

Output Example

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

Example3 Creating a task flow template that initiates a transcoding and sampled screencapturing task

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into three formats of 20, 30, and 40 and screencapture the video with sampled screencapturing template ID 10.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateProcedureTemplate
&Name=My Task Flow
&MediaProcessTask.TranscodeTaskSet.0.Definition=20
&MediaProcessTask.TranscodeTaskSet.1.Definition=30
&MediaProcessTask.TranscodeTaskSet.2.Definition=40
&MediaProcessTask.SampleSnapshotTaskSet.0.Definition=10
&<Common request parameters>

Output Example

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

Example4 Creating a task flow template that initiates an intelligent content audit task

This example shows you how to create a task flow template named "My Task Flow" to initiate an intelligent content audit task (including detection of porn, politically sensitive, and terrorism information) with content audit template ID 10.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateProcedureTemplate
&Name=My Task Flow
&AiContentReviewTask.Definition=10
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.ExistedProcedureName The task flow template name already exists.
InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
UnauthorizedOperation Unauthorized operation.