Submit an automated media review job using SubmitAIMediaAuditJob - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Submits an automated review job for audio and video files. The job is executed asynchronously after submission, and the job may not be complete when the response is returned.

Operation description

Before using this operation, make sure that you are familiar with the billing methods and pricing of ApsaraVideo VOD. Automated review is a paid feature. For billing details, submit a ticket or contact your Alibaba Cloud account manager.
This operation currently supports only the Shanghai, Beijing, and Singapore regions.
This is an asynchronous operation. After you submit a task, a task ID is returned. The task is not yet complete at this point and enters a queue for asynchronous execution. The final result is sent through a callback notification. You can also call Query automated review job to query the task status.
For the development guide on submitting automated review jobs, refer to Automated review.
After an automated review job is complete, the image resources generated during the job are retained for free for only two weeks in the VOD system bucket allocated by ApsaraVideo VOD. The images are automatically deleted after two weeks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:SubmitAIMediaAuditJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The audio or video ID. Log on to the ApsaraVideo VOD console and choose Review Management > Video Review to view the audio or video ID.	fe028d09441afffb138cd7ee****
TemplateId	string	No	The AI template ID. You can obtain the ID by using one of the following methods: When you call the AddAITemplate operation to add an AI template, the AI template ID is the value of the TemplateId response parameter. After the AI template is added, call the ListAITemplate operation to query the AI template ID, which is the value of the TemplateId response parameter. Note If you do not specify an AI template ID, the default AI template ID for automated review is used.	a07a7f7d7d10eb9fd999e56ecc****
UserData	string	No	The custom settings. The value is a JSON string that supports settings such as message callbacks. For more information, refer to UserData. Note To use message callbacks in this parameter, you must configure an HTTP callback URL and select the corresponding callback event types in the console. Otherwise, the callback settings do not take effect. For information about how to configure HTTP callbacks in the console, refer to Callback settings.	{"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}
MediaType	string	No		video
MediaAuditConfiguration	string	No		{"ResourceType":"****_movie"}
		No
		No
		No	The media type. Currently, only video is supported.	video
		No	The configuration of the review job. For other configuration items of the review job, only the ResourceType field is currently supported. This field controls the media file type, and you can adjust the review standards and rules for the specified type. To adjust the review standards and rules for a ResourceType, submit a ticket for technical support. For information about how to submit a ticket, refer to Contact us. Usage notes for ResourceType: Only letters, digits, and underscores (_) are allowed.	{"ResourceType":"****_movie"}

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F4631053-8D9F-42B2-4A67281DB88E****
MediaId	string	The audio or video ID.	fe028d09441afffb138cd7ee****
JobId	string	The job ID.	bdbc266af6893943a70176d92e99****

Examples

Success response

JSON format

{
  "RequestId": "F4631053-8D9F-42B2-4A67281DB88E****",
  "MediaId": "fe028d09441afffb138cd7ee****",
  "JobId": "bdbc266af6893943a70176d92e99****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.