Submit smart tagging or video fingerprinting jobs by calling SubmitAIJob - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Before using this operation, make sure that you fully understand the billing methods and pricing of ApsaraVideo VOD. Intelligent tagging and media fingerprint are paid features. For billing details, see Video AI billing.
Regions supported by media fingerprint: China (Beijing), China (Shanghai), and Singapore. Regions supported by intelligent tagging: China (Beijing) and China (Shanghai).
This is an asynchronous operation. After you submit an AI job, the job ID is returned. The job is not yet complete at this point and enters a queue for asynchronous execution. We recommend that you configure the event notification feature and set the callback event to Video AI Processing Complete to obtain the final processing result. You can also call GetTaskDetail to query the job status.
You must activate the media fingerprint or intelligent tagging service before you can call this operation to submit AI jobs. For more information, see Video AI.
When you use media fingerprint for the first time, provide your UID and region information and submit a ticket to apply for free activation of the fingerprint library. Otherwise, the media fingerprint feature will not work properly. For more information about how to submit a ticket, see Contact us.

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:SubmitAIJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	No	The video ID. You can obtain the video ID by using one of the following methods: For videos uploaded in the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the video ID is the value of the VideoId response parameter. After the video is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId response parameter.	3D3D12340d9401fab46a0b847****
Types	string	No	The AI job type. Separate multiple job types with commas (,). Valid values: AIMediaDNA: media fingerprint. AIVideoTag: intelligent tagging.	AIVideoTag
Config	string	No	The AI job configuration in JSON format. If `Types` is set to `AIVideoTag`, `Config` supports the `AnalyseTypes` parameter to specify the analysis algorithm types for the intelligent tagging job. Valid values: ASR: speech recognition. Identifies tags from the audio speech in the video. OCR: optical character recognition. Identifies tags from the text in the video images. If `Types` is set to `AIMediaDNA`, `Config` supports the `DNADBId` parameter to specify the fingerprint library ID for the media fingerprint job.	{"AIVideoTag": {"AnalyseTypes": "ASR"} }
UserData	string	No	The custom settings in JSON format. For more information about the parameter structure, see UserData.	{"Extend":{"localId":"***","test":"www"}}

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D73936****
AIJobList	object
AIJob	array<object>	The list of AI jobs.
	object	The details of the AI job.
Type	string	The type of the AI job. Valid values: AIMediaDNA: video DNA. AIVideoTag: smart tag.	AIVideoTag
JobId	string	The ID of the AI job.	9e82640c85114bf5af23edfaf****
MediaId	string	The ID of the video.	3D3D12340d92c641401fab46a0b847****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A13-BEF6-D73936****",
  "AIJobList": {
    "AIJob": [
      {
        "Type": "AIVideoTag",
        "JobId": "9e82640c85114bf5af23edfaf****",
        "MediaId": "3D3D12340d92c641401fab46a0b847****"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.