Skip to main content

FetchImageTask

Retrieve the results of image generation tasks.

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.

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

aimiaobi:FetchImageTask

get

*All Resource

*

NoneNone

Request parameters

Parameter

Type

Required

Description

Example

AgentKey

string

Yes

Unique identifier of the workspace: AgentKey

cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public

TaskIdList

array

Yes

List of task IDs

["9d8c9185-3f75-4a20-aca1-c5bb53dd97b3"]

string

No

TaskId, the unique identifier of a task

You do not need to specify TaskId by default. The system generates it automatically. When multiple tasks use the same TaskId, they belong to the same conversation group.

9c5ac65f-fcac-416c-81d0-4ab81e1373fd

ArticleTaskId

string

Yes

Article task ID

e1be065b-adc3-435e-bd01-1c18c5ed75d3

Response elements

Element

Type

Description

Example

object

PlainResult

Code

string

Status code

success

Data

object

Business data

TaskInfoList

array<object>

Image information generated by smart illustration tasks

array<object>

Id

integer

Paragraph ID

1

ImageList

array<object>

Image information

object

Code

string

Error code returned if the image was not generated

NoData

Message

string

Error message returned if the image was not generated

fault

Url

string

Image URL

http://www.example.com/aaa.png

TaskId

string

Task ID, the unique identifier of a task

net-7eb32699000d4193a3c59fc64ae1e55f

TaskStatus

string

Current task status. Values: SUCCESSED = task succeeded, FAILED = task failed, CANCELED = task canceled, PENDING = task queued, SUSPENDED = task suspended, RUNNING = task in progress

SUCCESSED

HttpStatusCode

integer

HTTP status code

200

Message

string

Error description

success

RequestId

string

Unique request identifier

DD656AF9-0839-521A-A3D2-F320009F9C87

Success

boolean

Indicates whether the request succeeded: true for success, false for failure

true

Examples

Success response JSON format
{
  "Code": "success",
  "Data": {
    "TaskInfoList": [
      {
        "Id": 1,
        "ImageList": [
          {
            "Code": "NoData",
            "Message": "fault",
            "Url": "http://www.example.com/aaa.png"
          }
        ],
        "TaskId": "net-7eb32699000d4193a3c59fc64ae1e55f",
        "TaskStatus": "SUCCESSED"
      }
    ]
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "DD656AF9-0839-521A-A3D2-F320009F9C87",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Agent Development
Agent Context
Agent Governance & Evolution
Store
Application Marketplace