Personalizedtxt2imgQueryImageAsset

更新时间:
复制 MD 格式

Retrieves the binary data of an image generated by the personalized text-to-image service.

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

get

*All Resource

*

None None

Request syntax

GET /api/v1/personalizedtxt2img/queryImageAsset HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

modelId

string

Yes

The ID of the model.

girl-xxxx-xxxx-xxxx-xxxx

promptId

string

Yes

The ID of the prompt.

xxxx-xxxx-xxxx-xxxx

imageId

string

Yes

The ID of the image.

0000.png

encodeFormat

string

No

The encoding format of the image. If this parameter is set to base64, the image is returned as a Base64-encoded string. If this parameter is omitted, the raw binary data of the image is returned.

base64

Response elements

Element

Type

Description

Example

any

The binary data of the image.

BinaryData

Examples

Success response

JSON format

"BinaryData"

Error codes

HTTP status code

Error code

Error message

Description

400 B_PARAMETER_NOT_FOUND_EXCEPTION 必要参数没有找到
500 UNKNOWN_ERROR The request processing has failed due to some unknown error.
403 B_PERMISSION_DENIED_EXCEPTION 鉴权失败或权限不足
404 B_DATA_NOT_FOUND_EXCEPTION 资源没有找到

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.