Ideogram 角色编辑

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

接口

POST /jobs/createTask

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

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

基于 ideogram/character-edit 模型实现图像生成

输出格式：WebP。

查询任务状态

提交任务后，可通过统一的查询端点查看任务进度并获取生成结果：

获取任务详情 — 了解如何查询任务状态并获取生成结果

TIP

生产环境中，建议使用 callBackUrl 参数接收生成完成的自动通知，而非轮询状态端点。

请求参数

请求体 (application/json)

参数	类型	必填	说明
`model`	`string`	是	用于生成任务的模型名称。必填字段。 - 该端点必须使用 `ideogram/character-edit` 模型默认值：`"ideogram/character-edit"`。可选值：`ideogram/character-edit`。示例：`ideogram/character-edit`。
`callBackUrl`	`string`	否	接收生成任务完成通知的回调 URL。可选配置，建议在生产环境中使用。 - 任务生成完成后，系统会向该 URL POST 任务状态与结果 - 回调内容包含生成的资源 URL 与任务相关信息 - 您的回调端点需要支持接收带 JSON 负载的 POST 请求 - 也可以选择调用任务详情端点，主动轮询任务状态 - 为确保回调安全性，请参阅 Webhook 校验指南了解签名验证实现方法示例：`https://your-domain.com/api/callback`。
`input`	`object`	否	生成任务的输入参数
`input.prompt`	`string`	是	用于填充图像蒙版区域的文本提示词（最大长度：5000 字符）示例：`造型惊艳，头部微微低垂，面带微笑向前看<br>`。
`input.image_url`	`string`	是	用于生成图像的基础图像 URL。应与蒙版宽高比一致。（为上传后的文件 URL，非文件内容；支持的类型：image/jpeg、image/png、image/webp；最大文件大小：10.0MB）示例：`https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp`。
`input.mask_url`	`string`	是	用于图像修复的蒙版 URL。应与底图宽高比一致。（为上传后的文件 URL，非文件内容；支持的类型：image/jpeg、image/png、image/webp；最大文件大小：10.0MB）示例：`https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp`。
`input.reference_image_urls`	`array<string>`	是	作为人物参考的图像集合。目前仅支持 1 张图像，其余图像将被忽略。（所有参考图像总大小不超过 10MB）。图像格式需为 JPEG、PNG 或 WebP（为上传后的文件 URL，非文件内容；支持的类型：image/jpeg、image/png、image/webp；最大文件大小：10.0MB）
`input.rendering_speed`	`string`	否	渲染速度。默认值："BALANCED" 默认值：`"BALANCED"`。可选值：`TURBO` / `BALANCED` / `QUALITY`。示例：`BALANCED`。
`input.style`	`string`	否	生成图像的风格类型。默认值："AUTO" 默认值：`"AUTO"`。可选值：`AUTO` / `REALISTIC` / `FICTION`。示例：`AUTO`。
`input.expand_prompt`	`boolean`	否	是否启用 MagicPrompt 功能优化生成请求。默认值：true（布尔值：true/false）示例：`true`。
`input.num_images`	`string`	否	生成图像数量默认值：`"1"`。可选值：`1` / `2` / `3` / `4`。示例：`1`。
`input.seed`	`integer`	否	随机数生成器的种子值

请求示例

bash

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "ideogram/character-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "造型惊艳，头部微微低垂，面带微笑向前看\n",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp",
    "mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768064644jodsmfhq.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "num_images": "1"
  }
}'

json

{
  "model": "ideogram/character-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "造型惊艳，头部微微低垂，面带微笑向前看\n",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp",
    "mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768064644jodsmfhq.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "num_images": "1"
  }
}

响应

200 — 请求成功

参数	类型	必填	说明
`code`	`integer`	是	请求状态码。请求失败时 HTTP 状态仍为 200，请始终以本字段判断：200 表示成功，其他值均表示失败，原因见 msg。常见值：401 API key 无效或缺失；402 积分不足；429 超出频率限制；422 或 500 请求未能处理（请先查看 msg、检查参数，再决定是否重试）。可选值：`200` / `401` / `402` / `404` / `422` / `429` / `433` / `455` / `500` / `501` / `505`。示例：`200`。
`msg`	`string`	是	响应消息，失败时的错误描述
`data`	`object`	是	—
`data.taskId`	`string`	是	可以使用任务 ID 与“获取任务详细信息”端点一起查询任务状态。

json

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

回调

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。示例：`18`。
`data.model`	`string`	否	图片编辑使用的模型示例：`ideogram/character-edit`。
`data.param`	`string`	否	创建任务时提交的参数，JSON 字符串格式示例：{"model":"ideogram/character-edit","callBackUrl":"https://your-domain.com/api/callback","input":{"prompt":"造型惊艳，头部微微低垂，面带微笑向前看\n","image_url":"https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp","mask_url":"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp","reference_image_urls":["https://file.aiquickdraw.com/custom-page/akr/section-images/1755768064644jodsmfhq.webp"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"num_images":"1"}}。
`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>`。

成功

json

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/character-edit",
    "state": "success",
    "param": "{\"model\":\"ideogram/character-edit\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"造型惊艳，头部微微低垂，面带微笑向前看\\n\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp\",\"mask_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768064644jodsmfhq.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"num_images\":\"1\"}}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.webp\"]}",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 18,
    "updateTime": 1786427040000
  }
}

失败

json

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/character-edit",
    "state": "fail",
    "param": "{\"model\":\"ideogram/character-edit\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"造型惊艳，头部微微低垂，面带微笑向前看\\n\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/17557680349256sa0lk53.webp\",\"mask_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768046014ftgvma28.webp\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768064644jodsmfhq.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"num_images\":\"1\"}}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 0,
    "updateTime": 1786427040000
  }
}

Ideogram 角色编辑 ​

接口 ​

查询任务状态 ​

相关资源 ​

请求参数 ​

请求体 (application/json) ​

请求示例 ​

响应 ​

200 — 请求成功 ​

回调 ​

onImageGenerated ​

Ideogram 角色编辑

接口

查询任务状态

相关资源

请求参数

请求体 (application/json)

请求示例

响应

200 — 请求成功

回调

onImageGenerated