认证
authorization string 必需
所有 API 均使用 Bearer Token 鉴权
获取 API Key：
访问 API Key 管理页面 获取 API Key
用法：
将以下 Header 添加到请求中：
Authorization: Bearer YOUR_API_KEY参数
model string 必需
请求使用的模型 ID
值: spark_edit_3_0_i2i
prompt string 必需
用于编辑图像的提示词
建议:
- 建议长度不超过 120 字符, 最长不超过 800 字符, prompt 过长有概率出图异常或不生效
- 编辑指令使用自然语言即可
- 每次编辑使用单指令会更好
- 局部编辑时指令描述尽量精准, 尤其是画面有多个实体的时候, 描述清楚对谁做什么, 能获取更精准的编辑效果
- 发现编辑效果不明显的时候, 可以调整一下编辑强度 scale, 数值越大越贴近指令执行
- 尽量使用清晰的, 分辨率高的底图, 动漫及豆包模型生成的图片编辑效果会更好
参考示例:
- 添加/删除实体: 添加/删除 xxx（删除图上的女孩 / 添加一道彩虹）
- 修改实体: 把 xxx 改成 xxx（把手里的鸡腿变成汉堡）
- 修改风格: 改成 xxx 风格（改成漫画风格）
- 修改色彩: 把 xxx 改成 xx 颜色（把衣服改成粉色的）
- 修改动作: 修改表情动作（让他哭/笑/生气）
- 修改环境背景: 背景换成 xxx（背景换成海边 / 在星空下）
默认值: ""（空字符串）
image string 必需
图片文件 URL 或者 Base64 编码. 此算法需输入 1 张图片
size string
输出图像尺寸, 格式如 1024x1024
seed integer
随机种子, 作为确定扩散初始状态的基础
若随机种子为相同正整数且其他参数均一致, 则生成图片极大概率效果一致
默认值: -1（随机）
scale number
影响文本描述的程度, 该值越大代表文本描述影响程度越大, 且输入图片影响程度越小
范围: 0 - 1
默认值: 0.5
轮询
由于图像生成需要时间, 您需要在创建任务后轮询任务状态
初始响应返回任务 ID 和初始状态. 实际的生成结果必须通过轮询任务状态端点来获取
响应格式
error object
错误信息. 仅在状态为 failed 时出现
code
string错误码
error_message
string详细错误信息
output array
生成结果. 仅在状态为 completed 时出现
content
array生成的图像内容列表
type
string资源类型
值:
imageurl
string图像 URL
size
integer图像大小（字节）
b64_json
stringBase64 编码的图像数据（仅当 response_format 为
b64_json时）
usage object
使用统计信息. 仅在状态为 completed 时出现
input_tokens
integer输入令牌数
output_tokens
integer输出令牌数
total_tokens
integer总令牌数
metadata object
元数据信息
错误码
| 错误码 | 描述 |
|---|---|
| 3014001 | 缺少模型 |
| 3014002 | 缺少提示词 |
| 3014003 | 缺少图像 |
| 3014004 | 提示词长度无效 |
| 3014005 | 图像格式无效 |
| 3014006 | 图像尺寸无效 |
| 3014007 | 尺寸参数无效 |
| 3014008 | 种子参数无效 |
| 3014009 | 引导强度无效 |
| 3014010 | 响应格式无效 |
| 3014095 | 内部生成错误 |
| 3014096 | 结果解析异常 |
| 3014097 | HTTP 错误响应 |
| 3014098 | 状态检查异常 |
| 3014099 | 任务创建异常 / 服务不可用 |