认证
authorization string 必需
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必需
请求使用的模型 ID
值: spark_dream_5_0
prompt string 必需
用于生成图像的提示词, 支持中英文.
建议不超过 300 个汉字或 600 个英文单词. 字数过多信息容易分散, 模型可能因此忽略细节, 只关注重点, 造成图片缺失部分元素.
image string | array
输入的图片信息, 支持 URL 或 Base64 编码.
图片 URL:请确保图片 URL 可被访问.
Base64 编码:请遵循此格式 data:image/<图片格式>;base64, <Base64编码>, 注意 <图片格式> 需小写, 如 data:image/png;base64, <base64_image>.
传入图片需要满足以下条件:
图片格式:jpeg, png, webp, bmp, tiff, gif
宽高比(宽/高)范围:1/16 到 16
宽高长度(px) > 14
大小:不超过 10MB
总像素:不超过 6000x6000=36000000 px(对单张图宽度和高度的像素乘积限制, 而不是对宽度或高度的单独值进行限制)
最多支持传入 14 张参考图.
size string
指定生成图像的尺寸信息, 支持以下两种方式, 不可混用.
方式 1:指定生成图像的分辨率, 并在 prompt 中用自然语言描述图片宽高比、图片形状或图片用途, 最终由模型判断生成图片的大小.
可选值:2K, 3K
方式 2:指定生成图像的宽高像素值.
总像素取值范围:2560x1440=3686400 到 3072x3072x1.1025=10404496
宽高比取值范围:1/16 到 16
采用方式 2 时, 需同时满足总像素取值范围和宽高比取值范围. 其中, 总像素是对单张图宽度和高度的像素乘积限制, 而不是对宽度或高度的单独值进行限制.
有效示例:3750x1250
总像素值 3750x1250=4687500, 符合 [3686400, 10404496] 的区间要求;宽高比 3750/1250=3, 符合 [1/16, 16] 的区间要求, 故该示例值有效.
无效示例:1500x1500
总像素值 1500x1500=2250000, 未达到 3686400 的最低要求;宽高 1500/1500=1, 虽符合 [1/16, 16] 的区间要求, 但因其未同时满足两项限制, 故该示例值无效.
推荐的宽高像素值:
| 分辨率 | 宽高比 | 宽高像素值 |
|---|---|---|
| 2K | 1:1 | 2048x2048 |
| 2K | 4:3 | 2304x1728 |
| 2K | 3:4 | 1728x2304 |
| 2K | 16:9 | 2848x1600 |
| 2K | 9:16 | 1600x2848 |
| 2K | 3:2 | 2496x1664 |
| 2K | 2:3 | 1664x2496 |
| 2K | 21:9 | 3136x1344 |
| 3K | 1:1 | 3072x3072 |
| 3K | 4:3 | 3456x2592 |
| 3K | 3:4 | 2592x3456 |
| 3K | 16:9 | 4096x2304 |
| 3K | 9:16 | 2304x4096 |
| 3K | 2:3 | 2496x3744 |
| 3K | 3:2 | 3744x2496 |
| 3K | 21:9 | 4704x2016 |
默认值: 2048x2048
sequential_image_generation string
控制是否关闭组图功能.
组图:基于您输入的内容, 生成的一组内容关联的图片.
auto:自动判断模式, 模型会根据用户提供的提示词自主判断是否返回组图以及组图包含的图片数量.
disabled:关闭组图功能, 模型只会生成一张图.
可选值: auto, disabled
默认值: disabled
sequential_image_generation_options object
组图功能的配置. 仅当 sequential_image_generation 为 auto 时生效.
max_images
integer指定本次请求, 最多可生成的图片数量.
取值范围:
1到15实际可生成的图片数量, 除受到 max_images 影响外, 还受到输入的参考图数量影响. 输入的参考图数量 + 最终生成的图片数量 ≤ 15 张.
默认值:
15
tools array<object>
配置模型要调用的工具.
当前参数暂不可用.
type
string指定使用的工具类型.
web_search:联网搜索功能.开启联网搜索后, 模型会根据用户的提示词自主判断是否搜索互联网内容(如商品、天气等), 提升生成图像的时效性, 但也会增加一定的时延.
实际搜索次数可通过字段
usage.tool_usage.web_search查询, 如果为0表示未搜索.
stream boolean
控制是否开启流式输出模式.
false:非流式输出模式, 等待所有图片全部生成结束后再一次性返回所有信息.
true:流式输出模式, 即时返回每张图片输出的结果. 在生成单图和组图的场景下, 流式输出模式均生效.
可选值: true, false
默认值: false
output_format string
指定生成图像的文件格式.
可选值: png, jpeg
默认值: jpeg
response_format string
指定生成图像的返回格式.
url:返回图片下载链接;链接在图片生成后 24 小时内有效, 请及时下载图片.
b64_json:以 Base64 编码字符串的 JSON 格式返回图像数据.
可选值: url, b64_json
默认值: url
watermark boolean
是否在生成的图片中添加水印.
false:不添加水印.
true:在图片右下角添加“AI生成”字样的水印标识.
可选值: true, false
默认值: true
optimize_prompt_options object
提示词优化功能的配置.
mode
string设置提示词优化功能使用的模式.
standard:标准模式, 生成内容的质量更高, 耗时较长.可选值:
standard默认值:
standard
轮询
由于结果生成需要时间,您需要在创建任务后轮询任务状态
初始响应只返回任务 ID 和初始状态等信息,最终生成结果需通过使用该任务 ID 轮询任务状态接口获取
轮询请求与响应示例见右侧
响应格式
error object
错误信息. 仅在状态为 failed 时出现.
code
string错误码
error_message
string详细错误信息
output object
生成结果输出.
content
array生成的图片列表
type
string资源类型
值:
imageurl
string图片 URL 地址
usage object
使用统计. 仅在状态为 completed 时出现.
metadata object
元数据信息.