SubmitAIImageJob-阿里云帮助中心

Operation description

This operation is available in the following service regions: China (Beijing) and China (Shanghai).
This is an asynchronous API. After you submit a job, the operation returns a job ID. The job is queued for asynchronous processing. The system delivers the result through a callback notification. You can also call the GetAIImageJobs operation to query the job status.

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

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The video ID. You can obtain the video ID in the following ways: To find the ID of a video uploaded from the console, log on to the ApsaraVideo VOD console and navigate to Media Assets > Audio/Video. If you upload a video by calling the CreateUploadVideo operation, the video ID is the `VideoId` in the response. After you upload a video, call the SearchMedia operation to query the video ID. The video ID is the `VideoId` in the response.	357a8748c5774*****89d2726e6436aa
AITemplateId	string	Yes	The AI image template ID. You can obtain the template ID in the following ways: If you create an image template by calling the AddAITemplate operation, the template ID is the `TemplateId` in the response. After you create a template, you can call the ListAITemplate operation to query the AI image template ID. The template ID is the `TemplateId` in the response.	ef1a8842cb9f*****cea80cad902e416
UserData	string	No	Custom settings. The value must be a JSON string. The value must include the `MessageCallback` or `Extend` parameter. The maximum length is 512 bytes. For more information about how to structure this parameter, see UserData.	{"Extend":{"localId":"****","test":"www"}}
AIPipelineId	string	No	The AI pipeline ID. Note If you leave this parameter empty, the system uses a default pipeline ID. If you need to perform batch imports, you must use a dedicated pipeline. To request a dedicated pipeline, submit a ticket or contact Alibaba Cloud after-sales support. For more information about how to submit a ticket, see Contact Us.	6492025b8f*****6ba5bb755a33438

Response elements

Element	Type	Description	Example
	object	The response object.
JobId	string	The AI image processing job 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.