认证
authorization string 必需
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必需
请求使用的模型 ID
值: spark_dream_3_0
prompt string 必需
用于生成图像的提示词, 中英文均可输入
除 "" 外不建议输入特殊的符号如 $
画面描述技巧:运用连贯的自然语言描述画面内容(主体+行为+环境等), 用短词语描述画面美学(风格、色彩、光影、构图等)
专业词汇英文表述:推荐使用词源语言或英文描述专业词汇, 以获更精准效果
图像用途说明:推荐写出图像用途和类型, 例如:用途 PPT 封面背景图、背景素材图 / 类型广告海报设计、纪实摄影
文字排版描述:将文字内容置于双引号 "" 内, 并通过指令描述文字的大小、字体、颜色、风格和位置, 实现排版效果的精确调整
use_pre_llm boolean
开启文本扩写. 会针对输入 prompt 进行扩写优化, 如果输入 prompt 较短建议开启, 如果输入 prompt 较长建议关闭
可选值: true, false
默认值: false
seed integer
随机种子, 作为确定扩散初始状态的基础, 默认 -1(随机). 若随机种子为相同正整数且其他参数均一致, 则生成图片极大概率效果一致
默认值: -1
scale number
影响文本描述的程度
范围: 1 到 10
默认值: 2.5
width integer
生成图像的宽
推荐 1.3K 左右分辨率, 画质更细腻, 综合指标平衡得较好;1K 图和 2K 图表现相对较弱
1.3K 建议比例及对应宽高(width*height):
1:1: 1328*1328
4:3: 1472*1104
3:2: 1584*1056
16:9: 1664*936
21:9: 2016*864
宽高范围小于 2048*2048 乘积, 都可正常出图
范围: 512 到 2048
默认值: 1328
height integer
生成图像的高
推荐 1.3K 左右分辨率, 画质更细腻, 综合指标平衡得较好;1K 图和 2K 图表现相对较弱
1.3K 建议比例及对应宽高(width*height):
1:1: 1328*1328
4:3: 1472*1104
3:2: 1584*1056
16:9: 1664*936
21:9: 2016*864
宽高范围小于 2048*2048 乘积, 都可正常出图
范围: 512 到 2048
默认值: 1328
轮询
由于图像生成需要时间, 您需要在创建任务后轮询任务状态
初始响应返回任务 ID 和初始状态. 实际的生成结果必须通过轮询任务状态端点来获取
响应格式
error object
错误信息. 仅在状态为 failed 时出现
code
string错误码
error_message
string详细错误信息
output array
生成结果. 仅在状态为 completed 时出现
content
array生成内容列表
type
string资源类型
值:
imageurl
string生成内容的 URL
size
integer图像大小
jobId
string远程任务 ID
usage object
使用统计. 仅在状态为 completed 时出现
cost
string总费用(美元)
discount
number折扣金额
metadata object
元数据信息
错误码
| 错误码 | 描述 |
|---|---|
| 003019001 | 缺少提示词 |
| 003019002 | 提示词长度无效, 1-800 字符 |
| 003019003 | use_pre_llm 参数无效 |
| 003019004 | 种子参数无效, 必须是 -1 或正整数 |
| 003019005 | scale 参数无效, 必须在 1-10 之间 |
| 003019006 | 宽高参数无效, 必须在 512-2048 之间且同时提供 |
| 003019007 | 宽高比无效, 必须在 1:3 到 3:1 之间 |
| 003019095 | 内部生成错误 |
| 003019096 | 结果解析异常 |
| 003019097 | HTTP 错误响应 |
| 003019098 | 状态检查异常 |
| 003019099 | 任务创建异常 |