创意海报生成API参考

本文介绍创意海报生成模型的输入输出参数。根据要求自动生成海报的背景和文字排版,支持多种海报风格。无需设计基础,轻松制作出彩作品,让创意触手可及。

相关指南创意海报生成

模型概览

模型名

模型简介

免费额度

计费单价

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

任务下发接口QPS限制

同时处理中任务数量

wanx-poster-generation-v1

创意海报生成,您的创意海报魔法工厂!它能够根据你的要求自动生成海报的背景和文字排版,支持多种海报风格,从宣传到祝福,让每一张海报都成为你的个性宣言。无需设计基础,轻松制作出彩作品,让创意触手可及。

免费额度:500

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

有效期:180

限时免费

2

1

前提条件

API调用准备:1、获取API Key;2、配置API Key到环境变量

HTTP调用

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

  • 创建任务:首先发送一个请求创建文生图任务,该请求会返回任务ID。

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

创建任务

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

请求头(Headers)

春节快乐海报

curl --location --request POST 'https://dashscope.aliyuncs.com/api/v1/services/aigc/text2image/image-synthesis' \
--header 'X-DashScope-Async: enable' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data-raw '{
    "model":"wanx-poster-generation-v1",
    "input": {
        "title":"春节快乐",
        "sub_title":"家庭团聚,共享天伦之乐",
        "body_text":"春节是中国最重要的传统节日之一,它象征着新的开始和希望",
        "prompt_text_zh":"灯笼,小猫,梅花",
        "wh_ratios":"竖版",
        "lora_name":"童话油画",
        "lora_weight":0.8,
        "ctrl_ratio":0.7,
        "ctrl_step":0.7,
        "generate_mode":"generate",
        "generate_num":1
    },
    "parameters":{}
}'

Authorization string 必选

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

X-DashScope-Async string 必选

是否使用DashScope异步调用。HTTP只支持异步调用,设置为enable

Content-Type string 必选

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

请求体(Request Body)

model string 必选

调用模型。创意海报生成模型为wanx-poster-generation-v1

parameters object 必选

其他模型调用参数,只需要输入一个空对象即可。示例:{}

input object 必选

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

属性

generate_mode string 必选

海报生成模式。

  • generate:默认模式。

  • sr:高分辨率模式。

  • hrf:高清修复模式。

  • 只能从["generate","sr","hrf"]中选择。海报生成的基础模式为"generate",选择此模式会返回海报图片的url(render_urls)和与其一一对应的辅助参数(auxiliary_parameters)。用户可从返回的结果中,选择需要进行分辨率提升(或者高清修复)的海报,通过二次调用,输入选中的海报对应的辅助参数,将generate_mode设置为"sr"(或者"hrf"),得到对应的高分辨率(高清修复)结果。

generate_num Int 可选

生成的海报数。该参数只在generate_mode=generate时有效。

取值范围:[1,4],默认为1。如果设置的值大于4,则默认生成4张图。

auxiliary_parameters string 可选

generate_mode为"sr"或"hrf"时为必选项。需要提升分辨率或者高清修复的海报图片对应的辅助参数,数量限制为1。

该字段必须为海报生成服务的"generate"模式所返回的辅助参数。

title string 必选

主标题。最多30个字符。例如,"春节快乐"。

sub_title string 可选

副标题。最多30个字符。例如,“家庭团聚,共享天伦之乐"。

body_text string 可选

正文。最多50个字符。例如:"春节是中国最重要的传统节日之一,它象征着新的开始和希望"

prompt_text_zh string 可选

中文提示词。例如,“小朋友画的可爱的龙,白色背景"

中文和英文提示词至少二选一设置,支持两个参数同时设置。两个字段字符数加起来最多50个字/单词。

prompt_text_en string 可选

的英文提示词。例如:"Children draw a lovely dragon, white background"。

中文和英文提示词至少二选一设置,支持两个参数同时设置。两个字段字符数加起来最多50个字/单词。

wh_ratios string 可选

生成海报的版式。

  • 横版:默认值。

  • 竖版

lora_name string 可选

海报风格名称。默认值为""。

海报风格枚举值及图示

  • 2D插画1

image.jpeg

  • 2D插画2

image.jpeg

  • 浩瀚星云

image.jpeg

  • 浓郁色彩

image.jpeg

  • 光线粒子

image.jpeg

  • 透明玻璃

image.jpeg

  • 剪纸工艺

image.jpeg

  • 折纸工艺

image.jpeg

  • 中国水墨

image.jpeg

  • 中国刺绣

image.jpeg

  • 真实场景

image.jpeg

  • 2D卡通

image.png

  • 儿童水彩

image.jpeg

  • 赛博背景

image.jpeg

  • 浅蓝抽象

image.jpeg

  • 深蓝抽象

image.jpeg

  • 抽象点线

image.jpeg

  • 童话油画

image.jpeg

lora_weight float 可选

海报风格权重,需要与lora_name参数配合使用。

取值范围:[0, 1],默认值为0.8。取值越接近1,海报风格越明显。

ctrl_ratio float 可选

留白效果权重,用于控制海报留白效果。

取值范围:[0, 1],默认值为0.7。取值越接近1,留白效果越好,但海报背景生成效果可能会受到负面影响。

ctrl_step float 可选

留白步数比例,用于控制海报留白效果。

取值范围:(0, 1],默认值为0.7。取值越接近1,留白效果越好,但是海报背景生成效果可能会受到负面影响。

creative_title_layout bool 可选

标题是否启用创意排版。默认值为false。

响应

成功响应

{
    "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:执行失败

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": "b67df059-ca6a-9d51-afcd-9b3c4456b1e2",
    "output": {
        "task_id": "d76ec1e8-ea27-4038-8913-235c88ef0f70",
        "task_status": "SUCCEEDED",
        "submit_time": "2024-05-16 13:50:01.247",
        "scheduled_time": "2024-05-16 13:50:01.354",
        "end_time": "2024-05-16 13:50:27.795",
        "render_urls": "√",
        "auxiliary_parameters": "√",
        "bg_urls":"√"
    }
    "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": "dccfdf23-b38e-97a6-a07b-f35118c1ada6",
    "output": {
        "task_id": "4cbabbdf-2c1f-43f4-b983-c2cc47f4c115",
        "task_status": "FAILED",
        "submit_time": "2024-05-16 14:15:14.103",
        "scheduled_time": "2024-05-16 14:15:14.154",
        "end_time": "2024-05-16 14:15:14.694",
        "code": "InvalidParameter",
        "message": "check input data style"
    }
}

output object

任务输出信息。

属性

task_id string

任务id。

task_status string

任务状态。

  • PENDING:排队中

  • RUNNING:处理中

  • SUSPENDED:挂起

  • SUCCEEDED:执行成功

  • FAILED:执行失败

render_urls list[string]

海报图像URL列表。海报图像URL有效时限为24小时。

  • generate_mode=generate时,返回1~4张海报图像的URL列表。

  • generate_mode=sr或者generate_mode=hrf时,返回1张海报图像的URL。

在返回海报图像URL之前,会进行敏感信息检测。如发现敏感内容,将拦截该图像,并替换为output data may contain inappropriate content

auxiliary_parameters List[String]

高清修复和提升分辨率的辅助参数,与render_urls列表的URL一一对应。有效时限为24小时。

接口返回的auxiliary_parameters可用于二次调用,将其作为入参,对海报进行分辨率提升或者高清修复。

在返回海报图像URL之前,会进行敏感信息检测。如发现敏感内容,将拦截该图像,并替换为output data may contain inappropriate content

bg_urls List[String]

不含文字的海报背景图URL。有效时限为24小时。

  • generate_mode=generate时,返回1~4张海报图像的URL列表。

  • generate_mode=sr或者generate_mode=hrf时,返回1张海报图像的URL。

在返回海报图像URL之前,会进行敏感信息检测。如发现敏感内容,将拦截该图像,并替换为output data may contain inappropriate content

task_metrics object

任务信息统计指标。

属性

TOTAL integer

总的任务数。

SUCCEEDED integer

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

FAILED integer

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

submit_time string

任务提交时间。

scheduled_time string

任务排期执行时间。

end_time string

任务完成时间。

code string

接口错误码。接口成功请求不会返回该参数。

message string

接口错误信息。接口成功请求不会返回该参数。

usage object

输出信息统计。

属性

image_count integer

生成图像的数量。

request_id string

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

错误码

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

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

HTTP状态码

接口错误码(code)

接口错误信息(message)

含义说明

400

InvalidParameter

check input data style

输入参数不满足入参要求

500

InternalError

inference error

算法内部错误