CreateWorkflow

Last updated: 2025-02-19 14:55:40Download PDF

1. API Description

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

This API is used to create a workflow for media files uploaded to a specified COS bucket. A workflow may include the following tasks:

Video transcoding (with watermark)
Animated image generating
Time point screencapturing
Sampled screencapturing
Image sprite generating
Adaptive bitrate streaming
Intelligent content moderation (detection of pornographic and sensitive content)
Intelligent content analysis (labeling, categorization, thumbnail generation, frame-specific labeling)
Intelligent content recognition (face, full text, text keyword, full speech, and speech keyword)

Note: A workflow is disabled upon creation. You need to manually enable it.

A maximum of 200 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: CreateWorkflow.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
WorkflowName	Yes	String	Workflow name of up to 128 characters, which must be unique for the same user.
Trigger	Yes	WorkflowTrigger	Triggering rule bound to a workflow. If an uploaded video hits the rule for the object, the workflow will be triggered.
OutputStorage	No	TaskOutputStorage	The location to save the output file of media processing. If this parameter is left empty, the storage location in `Trigger` will be inherited.
OutputDir	No	String	The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`. If you do not specify this, the file will be saved to the trigger directory.
MediaProcessTask	No	MediaProcessTaskInput	The media processing parameters to use.
AiContentReviewTask	No	AiContentReviewTaskInput	Type parameter of a video content audit task.
AiAnalysisTask	No	AiAnalysisTaskInput	Video content analysis task parameter.
AiRecognitionTask	No	AiRecognitionTaskInput	Type parameter of a video content recognition task.
TaskNotifyConfig	No	TaskNotifyConfig	Event notification configuration for a task. If this parameter is left empty, no event notifications will be obtained.
TaskPriority	No	Integer	Workflow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.

3. Output Parameters

Parameter Name	Type	Description
WorkflowId	Integer	Workflow ID.
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 Setting a transcoding rule

This example shows you how to set a transcoding rule named "trans-100020-100030-100040" to process the content in the TopRankVideo-125xxx88 bucket according to the transcoding templates 100020, 100030, and 100040.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=CreateWorkflow
&WorkflowName=trans-100020-100030-100040
&Trigger.Type=CosFileUpload
&Trigger.CosFileUploadTrigger.Bucket=TopRankVideo-125xxx88
&Trigger.CosFileUploadTrigger.Region=ap-chongqing
&Trigger.CosFileUploadTrigger.Dir=/movie/201907/
&MediaProcessTask.TranscodeTaskSet.0.Definition=100020
&MediaProcessTask.TranscodeTaskSet.1.Definition=100030
&MediaProcessTask.TranscodeTaskSet.2.Definition=100040
&<Common request parameters>

Output Example

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

Example2 Setting a sampled screenshot rule

This example shows you how to set a screenshot rule named "snapshot" to process the content in the TopRankVideo-125xxx88 bucket according to the screenshot template 100010.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=CreateWorkflow
&WorkflowName=snapshot
&Trigger.Type=CosFileUpload
&Trigger.CosFileUploadTrigger.Bucket=TopRankVideo-125xxx88
&Trigger.CosFileUploadTrigger.Region=ap-chongqing
&Trigger.CosFileUploadTrigger.Dir=/movie/201907/
&MediaProcessTask.SampleSnapshotTaskSet.0.Definition=100010
&<Common request parameters>

Output Example

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

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

Tencent Cloud CLI 3.0

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.CosStatusInavlid	Operation failed: COS service is suspended.
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.
ResourceNotFound.CosBucketNameInvalid	The resource does not exist: invalid COS bucket name.
ResourceNotFound.CosBucketNotExist	The resource does not exist: the COS bucket does not exist.