SubmitAIMediaAuditJob

Operation description

Before you call this operation, make sure you understand the billing methods and pricing of ApsaraVideo VOD. The intelligent review feature is a paid service. For more information, submit a ticket or contact your account manager.
This operation is available only in the China (Shanghai), China (Beijing), and Singapore regions.
This is an asynchronous API. After you submit a job, a job ID is returned. The job is then processed asynchronously. The final result is delivered via a callback. You can also call the GetAIMediaAuditJob operation to query the job status.
For guidelines on submitting intelligent review jobs, see Intelligent review.
After an intelligent review job completes, ApsaraVideo VOD stores the generated image resources in a system bucket for two weeks free of charge. After this period, the resources are automatically deleted.

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 ID of the audio or video file. To obtain the ID, log in to the ApsaraVideo VOD console and navigate to Review Management > Video Moderation.	fe028d09441afffb138cd7ee****
TemplateId	string	No	The ID of the AI template. You can obtain the template ID in one of the following ways: Call the AddAITemplate operation. The `TemplateId` in the response is the AI template ID. Call the ListAITemplates operation to query for existing AI template IDs. Note If you omit this parameter, ApsaraVideo VOD uses the default AI template for intelligent review.	a07a7f7d7d10eb9fd999e56ecc****
UserData	string	No	The custom settings. This parameter must be a JSON string. Use this parameter to specify settings, such as a message callback. For more information, see UserData. Note To use the message callback feature, you must configure a callback URL and select the corresponding callback event type in the ApsaraVideo VOD console. Otherwise, the callback settings do not take effect. For more information about configuring HTTP callbacks, see Callback settings.	{"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}
MediaType	string	No	The media type. Only video is supported.	video
MediaAuditConfiguration	string	No	Configurations for the review job. Additional configurations for the review job. Currently, only the `ResourceType` field is supported. Use this field to specify the media file type to adjust review standards and rules accordingly. To adjust the review standards and rules for a specific `ResourceType`, submit a ticket. For information about how to submit a ticket, see Contact us. The `ResourceType` value can contain only letters, digits, and underscores (_).	{"ResourceType":"****_movie"}

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	F4631053-8D9F-42B2-4A67281DB88E****
MediaId	string	The ID of the audio or video file.	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.