All Products
Search

This Product

    ApsaraVideo VOD:SubmitAIImageJob

    Document Center

    ApsaraVideo VOD:SubmitAIImageJob

    Last Updated:Jul 19, 2024

    Submits jobs of image AI processing.

    Operation description

    • Regions that support this operation: China (Beijing) and China (Shanghai).
    • After you call this operation, you can call the GetAIImageJobs operation to query the job execution result.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    VideoIdstringYes

    The ID of the video. You can use one of the following methods to obtain the ID:

    • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
    • Obtain the value of VideoId from the response to the CreateUploadVideo operation that you call to upload the video.
    • Obtain the value of VideoId from the response to the SearchMedia operation after you upload the video.
    		357a8748c5774*****89d2726e6436aa
    AITemplateIdstringYes

    The ID of the AI template. You can use one of the following methods to obtain the ID:

    • Obtain the value of TemplateId from the response to the AddAITemplate that you call to create the template.
    • Obtain the value of TemplateId from the response to the ListAITemplate operation after you create the template.
    		ef1a8842cb9f*****cea80cad902e416
    UserDatastringNo

    The user data.

    • The value must be a JSON string.
    • You must specify the MessageCallback or Extend parameter.
    • The value can contain a maximum of 512 bytes.

    For more information, see the "UserData: specifies the custom configurations for media upload" section of the Request parameters topic.

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

    The ID of the pipeline that is used for the AI processing job.

    Note This parameter is optional if you specify a default pipeline ID. If you want to use a separate pipeline to submit multiple AI processing jobs., submit a ticket or contact Alibaba Cloud after-sales engineers. For more information about how to submit a ticket, see Contact us.
    		6492025b8f*****6ba5bb755a33438

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    JobIdstring

    The ID of the image AI processing job.

    		cf08a2c6e11e*****de1711b738b9067
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.