Personalizedtxt2imgAddInferenceJob-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Creates an inference job to generate images based on a personalized text-to-image model.

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

aicontent:Personalizedtxt2imgAddInferenceJob

create

*All Resource

*

None

Request syntax

POST /api/v1/personalizedtxt2img/addInferenceJob HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
modelId	string	Yes	The model ID to use for the inference job.	xxxx-xxxx-xxxx
prompt	string	Yes	An English prompt describing the image to generate. Replace the subject with . For example, change "a man in the snow" to "a in the snow", and "a photo of a girl" to "a photo of a ".	a in the snow
imageNumber	integer	No	The number of images to generate. Note: Due to resource limits in the test environment, you can generate up to 10 images per request. The system automatically sets values greater than 10 to 10.	1
seed	integer	No	The seed for the random number generator. Using the same seed ensures reproducible results. The value must be between -1 and 2,147,483,647. If the value is outside this range or is not specified, the system automatically generates a suitable seed.	1

Response elements

Element	Type	Description	Example
	object	The response object.	{"success":true,"errCode":null,"errMessage":null,"requestId":"abec5678-3536-4808-ab5a-eb165cd9109f","data":{"id":"1","promptId":"prompt_id-xxxx-xxxx-xxxx-xxxx","modelId":"model_id-xxxx-xxxx-xxxx-xxxx","jobStatus":"NOT_START","resultImageUrl":null,"createUserId":"109988888888","createTime":"2024-06-28T11:02:32.441184"}}
requestId	string	The request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code.	UNKNOWN_ERROR
errMessage	string	The error message.	未知错误
httpStatusCode	integer	The HTTP status code.	200
data	object	The data object.	[]
id	string	The model inference job ID.	3220
promptId	string	The prompt ID.	promptId-xxxx-xxxx-xxxx
modelId	string	The model ID.	modelId-xxxx-xxxx-xxxx
jobStatus	string	The job status.	FINISHED
jobTrainProgress	number	The inference job progress.	0.5
resultImageUrl	array	A list of URLs for the generated images.	0000.png
	string
createTime	string	The inference job's creation time.	2023-12-25T12:00:00

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "id": "3220",
    "promptId": "promptId-xxxx-xxxx-xxxx",
    "modelId": "modelId-xxxx-xxxx-xxxx",
    "jobStatus": "FINISHED",
    "jobTrainProgress": 0.5,
    "resultImageUrl": [
      ""
    ],
    "createTime": "2023-12-25T12:00:00"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.