AnyText图文融合API详情

通义万相-AnyText图文融合，支持图文生成和文字编辑功能，可广泛应用于电商海报、Logo设计、创意涂鸦、表情包、儿童绘本等诸多场景。

AnyText模型支持两种调用模式：

• 文字生成：输入一段描述，以及一张标识文字位置的图片，即可生成一张带有文字的图片。例如：

  "一个儿童蜡笔画，森林里有一个可爱的蘑菇形状的房子，标题是“森林小屋”"+=

• 文字编辑：输入一张要编辑的原图，以及一张标识文字位置的图片，即可生成一张在指定位置做编辑的图片。例如：

  + + "精美的书法作品，上面写着“志” “存” “高” “远”" =

模型概览

HTTP调用接口

功能描述

本模型需要相对较长的算法调用时间，所以在接口层面采用了异步调用的方式进行任务提交，在通过任务接口提交作业之后，系统会返回对应的作业ID，随后可以通过对应的异步作业查询接口获取任务的状态，并在作业到达最终完成态后取回对应的作业结果。

前提条件

已开通服务并获得API-KEY：开通DashScope并创建API-KEY。

作业提交接口调用

https://dashscope.aliyuncs.com/api/v1/services/aigc/anytext/generation

入参描述

出参描述

请求示例

下示例展示通过CURL命令来调用本模型的脚本。

文字生成示例：

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/anytext/generation' \
--header 'X-DashScope-Async: enable' \
--header 'Authorization: Bearer <YOUR-DASHSCOPE-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "wanx-anytext-v1",
    "input": {
        "prompt": "一只浣熊站在黑板前，上面写着“深度学习”",
        "mask_image_url": "http://public-vigen-video.oss-cn-shanghai.aliyuncs.com/yuxiang.tyx/test_anytext/gen1.png"
    },
    "parameters": {
       "seed": 81808278
    }
}'

文字编辑示例：

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/anytext/generation' \
--header 'X-DashScope-Async: enable' \
--header 'Authorization: Bearer <YOUR-DASHSCOPE-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "wanx-anytext-v1",
    "input": {
        "prompt": "精美的书法作品，上面写着“志” “存” “高” “远”",
        "mask_image_url": "http://public-vigen-video.oss-cn-shanghai.aliyuncs.com/yuxiang.tyx/test_anytext/edit10.png",
        "base_image_url": "http://public-vigen-video.oss-cn-shanghai.aliyuncs.com/yuxiang.tyx/test_anytext/ref10.jpg"
    },
    "parameters": {
       "seed": 98053044
    }
}'

响应示例

{
    "output": {
      "task_id": "xxxxxxxx", 
      "task_status": "PENDING"
    }
    "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51"
}

异常响应示例

在提交作业请求出错的情况下，输出的结果中会通过 code 和 message 指明出错原因。

{
    "code":"InvalidApiKey",
    "message":"Invalid API-key provided.",
    "request_id":"fb53c4ec-1c12-4fc4-a580-cdb7c3261fc1"
}

作业任务状态查询和结果获取接口

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id} --header 'Authorization: <YOUR-DASHSCOPE-API-KEY>'

入参描述

出参描述

请求示例

以下示例展示通过CURL命令来调用本模型的脚本。

curl -X GET \
--header 'Authorization: Bearer <YOUR-DASHSCOPE-API-KEY>' \
https://dashscope.aliyuncs.com/api/v1/tasks/86ecf553-d340-4e21-af6e-a0c6a421c010

响应示例（作业执行中）

作业提交后将处于排队状态，在得到调度之后将转为运行状态，此时作业的状态为RUNNING。

{
    "request_id":"e5d70b02-ebd3-98ce-9fe8-759d7d7b107d",
    "output":{
        "task_id":"86ecf553-d340-4e21-af6e-a0c6a421c010",
        "task_status":"RUNNING"
        }
    }
}

响应示例（作业成功执行完毕）

如果作业执行完成并成功之后，再次查询作业状态，接口将在告知作业状态的同时，一并将作业的结果返回。对于本模型，作业在结束之后的状态会持续保留24小时以备客户随时查询，24小时之后，作业将从系统中清除，相关的结果也将一并清除；对应的，作业生成的结果为图像的URL地址，出于安全考虑，该URL的下载有效期也是24小时，需要用户在获取作业结果后根据需要及时使用或者转存。

{
    "request_id":"<your request id>",
    "output":{
        "task_id":"<your task id>",
        "task_status":"SUCCEEDED",
        "submit_time":"xxx",
        "scheduled_time":"xxx",
        "end_time":"xxx",
        "result_url":["http://oss.aliyuncs.com/xxx/abc.jpg"],
        "warning": ""
    },
    "usage":{
        "image_count":1
    }
}

响应示例（作业失败）

如果因为某种原因作业失败，则作业状态会设置为FAILED，并且通过status_name和status_message字段指明错误原因。

异常1，图片下载失败

{
  "header": {
    "status_code": 400, 
    "status_name": "InvalidURL", 
    "status_message": "Image download fail, please check the request URL"
  }, 
  "payload": {
    "output": {
      "output_img": [],
      "warning": ""
    }, 
    "usage": {
      "image_count": 0
    }
  }
}

异常2， 传入图片的尺寸太大或太小

{
  "header": {
    "status_code": 400, 
    "status_name": "InvalidFile.Resolution", 
    "status_message": "[draw_pos] Resolution needs to be between 64 and 7000"
  }, 
  "payload": {
    "output": {
      "output_img": [], 
      "warning": ""
    }, 
    "usage": {
      "image_count": 0
    }
  }
}

异常3， 传入的图片格式不对（非图像格式）

{
  "header": {
    "status_code": 400, 
    "status_name": "InvalidURL", 
    "status_message": "Image decode fail, please check the request image format is one of the following types: JPEG, JPG, PNG, BMP"
  }, 
  "payload": {
    "output": {
      "output_img": [],
      "warning": ""
    }, 
    "usage": {
      "image_count": 0
    }
  }
}

异常4，算法内部报错（传入的图片大小不对）

{
  "header": {
    "status_code": 500, 
    "status_name": "InternalError.Algo", 
    "status_message": "An internal error occurs during computation"
  }, 
  "payload": {
    "output": {
      "output_img": [],
      "warning": ""
    }, 
    "usage": {
      "image_count": 0
    }
  }
}

异常5，传入的图片文件超限

{
  "header": {
    "status_code": 400, 
    "status_name": "InvalidURL", 
    "status_message": "mask_image_url file size (7.23MB) exceeds the maximum limit: 5MB"
  }, 
  "payload": {
    "output": {
      "output_img": [], 
      "warning": ""
    }, 
    "usage": {
      "image_count": 0
    }
  }
}

状态码说明

DashScope灵积模型服务通用状态码请查阅：返回状态码说明

同时本模型还有如下特定错误码：