Cosplay动漫人物生成API参考

本文介绍通义万相-Cosplay动漫人物模型的输入输出参数。通过输入人像图片和卡通形象图片,可快速生成人物卡通写真。

相关指南Cosplay动漫人物生成

模型概览

模型名

模型简介

免费额度

计费单价

限流(含主账号与RAM子账号)

任务下发接口QPS限制

同时处理中任务数量

wanx-style-cosplay-v1

通义万相-Cosplay动漫人物生成。

免费额度:500

领取方式:开通阿里云百炼大模型服务后,自动发放

有效期:180

限时免费

2

1

前提条件

您需要已获取API Key配置API Key到环境变量。如果通过SDK调用,还需要安装DashScope SDK

HTTP调用

为了减少等待时间并且避免请求超时,服务采用异步处理方法。您需要发起两个请求:

  • 创建任务:您首先发送一个请求创建Cosplay动漫人物生成任务,该请求返回任务ID。

  • 根据任务ID查询结果:使用上一步获得的任务ID,查询模型生成的结果。

创建任务

POST https://dashscope.aliyuncs.com/api/v1/services/aigc/image-generation/generation

请求头(Headers)

3D卡通人物写真生成

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
--header 'X-DashScope-Async: enable' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
    "model": "wanx-style-cosplay-v1",
    "input": {
        "model_index": 1,
        "face_image_url": "http://xxx/image.jpg1",
        "template_image_url": "http://xxx/image.jpg2"
    }
}'

Authorization string 必选

推荐您使用百炼API-Key,也可填DashScope API-Key。例如:Bearer d1xxx2a。

X-DashScope-Async string 必选

是否开启异步处理。必须开启异步处理,设置为enable

Content-Type string 必选

请求内容类型。固定为application/json

请求体(Request Body)

model string 必选

调用模型。Cosplay动漫人物生成模型为wanx-style-cosplay-v1

input object 必选

输入图像的基本信息,比如图像URL地址。

属性

face_image_url string 必选

人脸图像URL地址。例如:http://xxx/image.jpg。

图像要求:

  • 图像格式:JPEG、PNG、JPG、BMP、WEBP。

  • 图像大小:不超过10MB。

  • 图像分辨率:不小于256×256像素且不超过5760×3240像素。

  • 图像比例:长宽比不超过1.8:1。

  • URL地址中不能包含中文字符。

template_image_url string 必选

模板图像URL地址。

  • 图像格式:JPEG、PNG、JPG、BMP、WEBP。

  • 图像大小:不超过10MB。

  • 图像分辨率:不小于256×256像素且不超过5760×3240像素。

  • 图像比例:长宽比不超过1.8:1。

  • URL地址中不能包含中文字符。

model_index integer 必选

风格类型。目前支持的风格:

  • 1:3D卡通形象(3d cartoon)。

响应

成功响应

{
    "output": {
	"task_id": "d76ec1e8-ea27-4038-8913-xxxxxxxxxxxx", 
        "task_status": "PENDING"
    }
    "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51"
}

异常响应

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

output object

任务输出信息。

属性

task_id string

任务id。

task_status string

任务状态。

  • PENDING:排队中

  • RUNNING:处理中

  • SUSPENDED:挂起

  • SUCCEEDED:执行成功

  • FAILED:执行失败

  • UNKNOWN:任务不存在或状态未知

code string

任务执行失败的错误码。

message string

任务执行失败的详细信息。

request_id string

请求唯一标识。可用于请求明细溯源和问题排查。

根据任务ID查询结果

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

请求头(Headers)

获取任务结果

curl --location --request GET 'https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Authorization string 必选

推荐使用百炼API-Key,也可填DashScope API-Key。例如:Bearer d1xxx2a。

URL路径参数(Path parameters)

task_id string 必选

任务id。

响应

任务执行成功

{
    "request_id":"<your request id>",
    "output":{
        "task_id":"<your task id>",
        "task_status":"SUCCEEDED",
        "submit_time":"2024-05-16 13:50:xx.xxx",
        "scheduled_time":"2024-05-16 13:50:xx.xxx",
        "end_time":"2024-05-16 13:50:xx.xxx",
        "error_message":"Success",
        "start_time":"2024-05-16 13:50:xx.xxx",
        "model_index":0,
        "error_code":0,
        "result_url":"http://oss.aliyuncs.com/xxx/abc.jpg"
    },
    "usage":{
        "image_count":1
    }
}

任务执行中

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

任务执行失败

{
  "request_id": "<your request id>",
  "output": {
    "task_id": "<your task id>",
    "task_status": "FAILED",
    "submit_time": "2024-05-16 13:50:xx.xxx",
    "scheduled_time": "2024-05-16 13:50:xx.xxx",
    "end_time": "2024-05-16 13:50:xx.xxx",
    "code": "InvalidImageResolution",
    "message": "The input image resolution is too large or small"
  },
  "usage": {
    "image_num": 0
  }
}

output object

任务输出信息。

属性

task_id string

任务id。

task_status string

任务状态。

  • PENDING:排队中

  • RUNNING:处理中

  • SUSPENDED:挂起

  • SUCCEEDED:执行成功

  • FAILED:执行失败

  • UNKNOWN:任务不存在或状态未知

task_metrics object

任务信息统计指标。

属性

TOTAL integer

总的任务数。

SUCCEEDED integer

任务状态为成功的任务数。

FAILED integer

任务状态为失败的任务数。

submit_time string

任务提交时间。

scheduled_time string

任务排期执行时间。

start_time string

任务完成时间。

end_time string

任务完成时间。

result_url string

输出图片URL地址。可以在 24 小时之内随时下载。

model_index integer

风格类型。

code string

任务执行失败的错误码。

message string

任务执行失败的详细信息。

error_code integer

错误码。模型自定义的错误码。

error_message string

错误信息。模型自定义的错误信息。

usage object

输出信息统计。

属性

image_count integer

生成图像的数量。

request_id string

请求唯一标识。可用于请求明细溯源和问题排查。

错误码

如果模型调用失败并返回报错信息,请参见错误码进行解决。

API还有特定状态码,具体如下所示。

HTTP状态码

接口错误码(code)

接口错误信息(message)

含义说明

400

InvalidURL

The request URL is invalid, make sure the url is correct and is an image

输入URL错误,请确保URL链接的正确性

400

InvalidImageResolution

The input image resolution is too large or small

输入图像分辨率过大或过小

400

InvalidFace

The input image has no valid face

输入图像中检测不到人脸