ProcessMediaByUrl

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: ProcessMediaByUrl.
Version	Yes	String	Common Params. The value used for this API: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
InputInfo	No	MediaInputInfo	This API isdisused. You are advised to use an alternative API. For more information, see API overview.
OutputInfo	No	MediaOutputInfo	Information of COS path to output file.
AiContentReviewTask	No	AiContentReviewTaskInput	Type parameter of video content audit task.
AiAnalysisTask	No	AiAnalysisTaskInput	Video content analysis task parameter.
AiRecognitionTask	No	AiRecognitionTaskInput	Type parameter of video content recognition task.
TasksPriority	No	Integer	Task flow priority. The higher the value, the higher the priority. Value range: -10-10. If this parameter is left empty, 0 will be used.
TasksNotifyMode	No	String	Notification mode for task flow status change. Valid values: Finish, Change, None. If this parameter is left empty, `Finish` will be used.
SessionContext	No	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
SessionId	No	String	Used to identify duplicate requests. After you send a request, if any request with the same `SessionId` has already been sent in the last three days (72 hours), an error message will be returned. `SessionId` contains up to 50 characters. If this parameter is not carried or is an empty string, no deduplication will be performed.
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.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	Task 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 Initiating an inappropriate information recognition task

This example shows you how to initiate an inappropriate information recognition task for a video whose URL is http://www.abc.com/abc.mp4.

Input Example

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

{
    "InputInfo": {
        "Url": "http://www.abc.com/abc.mp4",
        "Name": "National Diplomacy",
        "Id": "872988202"
    },
    "OutputInfo": {
        "Region": "ap-guangzhou",
        "Bucket": "myoutputbucket-1256244234",
        "Dir": "/output/test/"
    },
    "AiContentReviewTask": {
        "Definition": "10"
    }
}

Output Example

{
    "Response": {
        "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
        "TaskId": "125xxxxxx07-procedurev2-893dc41e6fdc22dcf24aa6e9c61cp94"
    }
}

Example2 Initiating a content analysis task

This example shows you how to initiate a content analysis task for the video whose URL is http://www.abc.com/abc.mp4.

Input Example

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

{
    "InputInfo": {
        "Url": "http://www.abc.com/abc.mp4",
        "Name": "National Diplomacy",
        "Id": "872988202"
    },
    "OutputInfo": {
        "Region": "ap-guangzhou",
        "Bucket": "myoutputbucket-1256244234",
        "Dir": "/output/test/"
    },
    "AiAnalysisTask": {
        "Definition": "10"
    }
}

Output Example

{
    "Response": {
        "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
        "TaskId": "125xxxxxx07-procedurev2-813dc41e6fdc22dcf24aa6e9c61cp92"
    }
}

Example3 Initiating a content recognition task

This example shows you how to initiate a content recognition task for the video whose URL is http://www.abc.com/abc.mp4.

Input Example

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

{
    "InputInfo": {
        "Url": "http://www.abc.com/abc.mp4",
        "Name": "National Diplomacy",
        "Id": "872988202"
    },
    "OutputInfo": {
        "Region": "ap-guangzhou",
        "Bucket": "myoutputbucket-1256244234",
        "Dir": "/output/test/"
    },
    "AiRecognitionTask": {
        "Definition": "10"
    }
}

Output Example

{
    "Response": {
        "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064fk3",
        "TaskId": "125xxxxxx07-procedurev2-813dc41e6fdc22dcf24aa6e9c61f3t0"
    }
}

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	Operation failed.
FailedOperation.InvalidVodUser	The VOD service is not activated.
FailedOperation.TaskDuplicate	Operation failed: the task already exists.
InternalError	Internal error.
InternalError.GetFileInfoError	Internal error: an error occurred while getting media file information.
InvalidParameter	Invalid parameter.
InvalidParameterValue.AiAnalysisTaskDefinition	Incorrect parameter value: `Definition` for AI-based analysis.
InvalidParameterValue.AiContentReviewTaskDefinition	Incorrect parameter value: `Definition` AI-based content audit.
InvalidParameterValue.AiRecognitionTaskDefinition	Incorrect parameter value: `Definition` for AI-based recognition.
InvalidParameterValue.SessionContextTooLong	`SessionContext` is too long.
InvalidParameterValue.SessionId	The deduplication ID already exists. The request is removed due to duplication.
InvalidParameterValue.SessionIdTooLong	`SessionId` is too long.
InvalidParameterValue.SubAppId	Incorrect parameter value: subapplication ID
UnauthorizedOperation	Unauthorized operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Initiating an inappropriate information recognition task

Input Example

Output Example

Example2 Initiating a content analysis task

Input Example

Output Example

Example3 Initiating a content recognition task

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code