All Products
Search

This Product

    ApsaraVideo VOD:SubmitAIImageJob

    Document Center

    ApsaraVideo VOD:SubmitAIImageJob

    Last Updated:Jul 21, 2026

    Submits an AI image processing task.

    Operation description

    • Currently, this operation is supported in the following regions: China (Beijing) and China (Shanghai).

    • This is an asynchronous operation. After you submit a task, the task ID is returned. The task is not yet complete at this point and enters a background queue for asynchronous execution. The final result is sent through a callback notification. You can also call GetAIImageJobs to query the task execution result.

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

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VideoId

    string

    Yes

    The video ID. You can obtain the video ID by using one of the following methods:

    • For videos uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID.

    • When you upload a video by calling the CreateUploadVideo operation, the video ID is the value of the VideoId parameter in the response.

    • After the video is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId parameter in the response.

    357a8748c5774*****89d2726e6436aa
    AITemplateId

    string

    Yes

    The AI image template ID. You can obtain the template ID by using one of the following methods:

    • When you create an image template by calling the AddAITemplate operation, the template ID is the value of the TemplateId parameter in the response.

    • After the template is created, you can call the ListAITemplate operation to query the AI image template ID, which is the value of the TemplateId parameter in the response.

    ef1a8842cb9f*****cea80cad902e416
    UserData

    string

    No

    The custom settings.

    • The value must be a JSON string.

    • The value must contain the MessageCallback or Extend parameter.

    • The maximum length is 512 bytes.

    For more information about the parameter structure, see UserData.

    {"Extend":{"localId":"****","test":"www"}}
    AIPipelineId

    string

    No

    The AI task pipeline ID.

    Note

    A default ID is available, so this parameter is optional. If you need to perform batch imports, use a separate task pipeline. Submit a ticket to request configuration or contact Alibaba Cloud after-sales support for configuration. For more information about how to submit a ticket, see Contact us.

    6492025b8f*****6ba5bb755a33438

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    JobId

    string

    The AI image processing task ID.

    cf08a2c6e11e*****de1711b738b9067
    RequestId

    string

    The request ID.

    218A6807-A21E-43*****54-C0512880B0B0

    Examples

    Success response

    JSON format

    {
  "JobId": "cf08a2c6e11e*****de1711b738b9067",
  "RequestId": "218A6807-A21E-43*****54-C0512880B0B0"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.