Ideogram V3 图像编辑

本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致；品牌与 API 域名已替换为 ModelFold。

接口

POST /jobs/createTask

完整 URL: https://ai.modelfold.online/v1/jobs/createTask

鉴权：所有请求都需要 Authorization: Bearer <API_KEY> 请求头。

通过 ideogram/v3-edit 进行生成

输出格式：WebP。

创建任务

调用该接口可创建一个新的图像编辑生成任务。

• 查询任务详情 — 提交任务后，可通过统一查询接口查看任务进度并获取生成结果

TIP

生产环境建议优先使用 callBackUrl 参数接收任务完成通知，而不是持续轮询任务状态接口。

相关资源

• 模型市场 — 浏览全部可用模型与能力
• 通用 API — 查看账户积分与调用情况

请求参数

请求体 (application/json)

参数	类型	必填	说明
model	string	是	用于生成任务的模型名称。必填字段。 - 该端点必须使用 ideogram/v3-edit 模型 默认值："ideogram/v3-edit"。 可选值：ideogram/v3-edit。 示例：ideogram/v3-edit。
callBackUrl	string	否	接收任务完成通知的回调 URL。可选参数；如果提供，系统会在任务完成（成功或失败）后向该地址发送 POST 请求；如未提供，则不会发送回调通知。 示例：https://your-domain.com/api/callback。
input	object	是	图像编辑任务的输入参数。
input.prompt	string	是	用于填充图像蒙版区域的文本提示词（最大长度：5000 字符）。 示例：一只戴着牛仔帽的狗。
input.image_url	string	是	用于生成的原始图像 URL。需要与蒙版图像尺寸一致。 - 请提供上传后文件的 URL，而非文件内容 - 支持类型：image/jpeg、image/png、image/webp - 最大文件大小：10.0MB 示例：https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp。
input.mask_url	string	是	用于图像修复的蒙版 URL。需要与输入图像尺寸一致。 - 请提供上传后文件的 URL，而非文件内容 - 支持类型：image/jpeg、image/png、image/webp - 最大文件大小：10.0MB 示例：https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp。
input.rendering_speed	string	否	生成时使用的渲染速度。默认值：BALANCED。 - TURBO: 极速 - BALANCED: 均衡 - QUALITY: 高质量 默认值："BALANCED"。 可选值：TURBO / BALANCED / QUALITY。 示例：BALANCED。
input.expand_prompt	boolean	否	是否在生成请求中启用 MagicPrompt。默认值：true。 - 布尔值：true / false 默认值：true。 示例：true。
input.seed	integer	否	随机数生成器的种子值。

请求示例

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "ideogram/v3-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "一只戴着牛仔帽的狗",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp",
    "mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp",
    "rendering_speed": "BALANCED",
    "expand_prompt": true,
    "seed": 123456
  }
}'

{
  "model": "ideogram/v3-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "一只戴着牛仔帽的狗",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp",
    "mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp",
    "rendering_speed": "BALANCED",
    "expand_prompt": true,
    "seed": 123456
  }
}

响应

200 — 请求成功

参数	类型	必填	说明
data	object	否	—
data.taskId	string	否	任务 ID，可用于调用任务详情接口查询任务状态。 示例：task_ideogram_1765180586443。

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_ideogram_1765180586443"
  }
}

500 — 服务器错误

回调

onImageGenerated

回调地址：{$request.body#/callBackUrl}（即请求体里的 callBackUrl）。

任务成功或失败时发送回调。

回调体参数

参数	类型	必填	说明
code	integer	否	200：成功；501：失败，原因见 data.failCode 与 data.failMsg。 可选值：200 / 501。 示例：200。
msg	string	否	状态消息 示例：Playground task completed successfully.。
data	object	否	—
data.completeTime	integer	否	任务完成时间，Unix 毫秒时间戳 示例：1786427040000。
data.costTime	integer	否	处理耗时（秒），成功和失败回调都会返回。 示例：48。
data.createTime	integer	否	任务创建时间，Unix 毫秒时间戳 示例：1786426989000。
data.creditsConsumed	number	否	本任务消耗的积分；失败任务为 0。 示例：7。
data.model	string	否	图片编辑使用的模型 示例：ideogram/v3-edit。
data.param	string	否	创建任务时提交的参数，JSON 字符串格式 示例：{"model":"ideogram/v3-edit","callBackUrl":"https://your-domain.com/api/callback","input":{"prompt":"一只戴着牛仔帽的狗","image_url":"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp","mask_url":"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp","rendering_speed":"BALANCED","expand_prompt":true,"seed":123456}}。
data.resultJson	string	否	图片生成结果，JSON 字符串格式。resultUrls 为生成图片的 URL 列表。仅在 state 为 success 时出现。 示例：{"resultUrls":["https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.webp"]}。
data.state	string	否	任务状态 可选值：success / fail。 示例：success。
data.taskId	string	否	任务 ID 示例：4e029a320e97cff234e6e06827c3965e。
data.updateTime	integer	否	完成时间请以 completeTime 为准；updateTime 可能与 createTime 相同。 示例：1786427040000。
data.failCode	string	否	失败码，数字字符串，如 "400"、"500"。仅在 state 为 fail 时出现。 示例：500。
data.failMsg	string	否	失败原因，仅在 state 为 fail 时出现。 示例：<error detail>。

成功

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/v3-edit",
    "state": "success",
    "param": "{\"model\":\"ideogram/v3-edit\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"一只戴着牛仔帽的狗\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp\",\"mask_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp\",\"rendering_speed\":\"BALANCED\",\"expand_prompt\":true,\"seed\":123456}}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.webp\"]}",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 7,
    "updateTime": 1786427040000
  }
}

失败

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/v3-edit",
    "state": "fail",
    "param": "{\"model\":\"ideogram/v3-edit\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"一只戴着牛仔帽的狗\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp\",\"mask_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp\",\"rendering_speed\":\"BALANCED\",\"expand_prompt\":true,\"seed\":123456}}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 0,
    "updateTime": 1786427040000
  }
}