Image and text composition API reference

Image and text composition

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/text2image/image-synthesis' \
--header 'X-DashScope-Async: enable' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
    "model": "wanx-ast",
    "input": {
        "title": ["Lorem Ipsum"],
        "subtitle": ["Duis aute irure dolor in reprehenderit"],
        "text": ["VIEW NOW"],
        "image_url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20240929/vbxgxc/2.png",
        "underlay": 1,
        "logo": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20240927/abtbdg/logo.png"
    },
    "parameters": {
        "n": 1,
        "temperature": 0.7
    }
}'

Task succeeded

Task results, including image URLs, are available for 24 hours. You must save any generated images within this period, as the task and all associated data are deleted afterward.

{
    "request_id": "85eaba38-0185-99d7-8d16-4d9135238846",
    "output": {
        "task_id": "86ecf553-d340-4e21-af6e-a0c6a421c010",
        "task_status": "SUCCEEDED",
        "results": [
            {
                "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/123/a1.png"
            },
            {
                "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/123/b2.png"
            }
        ],
        "task_metrics": {
            "TOTAL": 2,
            "SUCCEEDED": 2,
            "FAILED": 0
        }
    },
    "usage": {
        "image_count": 2
    }
}

Partial success

This model can generate multiple images in a single request. The task is marked as SUCCEEDED as long as at least one image is generated successfully. When you query the task, the response includes the successful results. If an image fails to generate, the response includes the corresponding failure reason. You are only billed for successfully generated images.

{
  "request_id":"<your request id>",
  "output":{
    "task_id":"<your task id>",
    "task_status":"SUCCEEDED",
    "results":[
      {
        "url":"https://xxx.com/xxx/xxx.png"
      },
      {
        "code": "InternalError.Timeout",
        "message": "An internal timeout error has occured during execution, please try again later or contact service support."
      }
    ],
    "task_metrics":{
      "TOTAL":2,
      "SUCCEEDED":1,
      "FAILED":1
    }
  },
  "usage":{
    "image_count":1
  }
}

Task running

{
    "request_id":"<your request id>",
    "output":{
        "task_id":"<your task id>",
        "task_status":"RUNNING",
        "task_metrics":{
            "TOTAL":1,
            "SUCCEEDED":1,
            "FAILED":0
        }
    }
}