tencent cloud

All product documents
Video on Demand
DocumentationVideo on DemandServer APIsTask Flow APIsCreateProcedureTemplate
CreateProcedureTemplate
Download PDF
Last updated: 2024-03-27 16:08:07
CreateProcedureTemplate
Last updated: 2024-03-27 16:08:07
Download PDF

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.

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 (up to 20 characters).
SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
Comment No String Template description. Length limit: 256 characters.
MediaProcessTask No MediaProcessTaskInput Parameter of video processing task.
AiContentReviewTask No AiContentReviewTaskInput The information of the intelligent moderation task*.
*: This parameter is used by our old moderation templates and is not recommended. Please use ReviewAudioVideoTask instead.
AiAnalysisTask No AiAnalysisTaskInput Parameter of AI-based content analysis task.
AiRecognitionTask No AiRecognitionTaskInput Type parameter of AI-based content recognition task.
ReviewAudioVideoTask No ProcedureReviewAudioVideoTaskInput The information of the 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 initiate an intelligent recognition task

This example shows you how to create a task flow template named "My Task Flow" to recognize pornographic, terrorism, and politically sensitive content using an intelligent recognition 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"
    }
}

Example2 Creating a task flow template to initiate transcoding tasks with watermarked outputs

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into outputs in three formats (20, 30, and 40), and to watermark each output video using a watermark template (ID: 15780).

Input Example

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

Output Example

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

Example3 Creating a task flow template to initiate transcoding and sampled screenshot tasks

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into outputs in three formats (20, 30, and 40) and take sampled screenshots by using a sampled screenshot 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 to initiate transcoding tasks

This example shows you how to create a task flow template named "My Task Flow" to transcode a video into outputs in three formats (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"
    }
}

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 Invalid parameter.
InvalidParameter.ExistedProcedureName The task flow template name already exists.
InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
LimitExceeded Quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon