跳转到主要内容
POST
  1. 提交后会返回 task_id。如果提供了 callback_url,当任务状态变为 finished 或 failed 时,系统会向 callback_url 发送 POST 请求。
  2. 无论是否提供 callback_url,都可以通过统一的查询任务状态接口获取结果。
根据文本提示词生成图像,或结合参考图、可选蒙版和精度控制编辑一张主图。

模型

  • ideogram-v4.5 - 文生图,支持质量和尺寸控制
  • ideogram-v4.5-edit - 编辑恰好一张主图,可选参考图、蒙版和精度控制

必填参数

  • model:ideogram-v4.5 或 ideogram-v4.5-edit
  • input.prompt:两个模型均必填。使用 1-10000 个字符,且须包含非空白文本
  • input.image_urls:ideogram-v4.5-edit 必填。恰好一张主图。ideogram-v4.5 不支持

可选参数

  • n:输出图像数量。取值为 1 到 8 的整数。默认为 1
  • quality:输出质量。默认为 medium。ideogram-v4.5 接受 low、medium 和 high。ideogram-v4.5-edit 还接受 very_low
  • size:输出尺寸。参见下方的尺寸规则
  • reference_image_urls:仅限编辑。不使用蒙版时最多四张参考图,设置 mask_url 时最多三张
  • mask_url:仅限编辑。必须与主图尺寸一致,且同时包含黑色编辑区域和白色保留区域。图像内容要求在处理过程中检查。需要 size=auto 或省略 size
  • edit_precision:仅限编辑。regular 或 high。默认为 regular。high 会还原未改动的像素,需要 size=auto 或省略 size
  • callback_url:可选的 Webhook URL,用于任务完成通知
所有图像字段都接受公开的 HTTP(S) 图像 URL 或图像 data URI。

尺寸

ideogram-v4.5 默认为 1:1 HD。它接受宽高比 1:1、1:1 HD、4:3、3:4、16:9 和 9:16,或以下任一精确尺寸: 1024x1024, 1024x3072, 1120x896, 1152x2944, 1152x864, 1248x3328, 1248x832, 1280x3072, 1280x720, 1280x800, 1296x3168, 1440x2560, 1440x2880, 1440x720, 1600x2560, 1664x2496, 1728x2304, 1792x2240, 2048x2048, 2240x1792, 2304x1728, 2496x1664, 2560x1440, 2560x1600, 2880x1440, 2944x1152, 3072x1024, 3072x1280, 3168x1296, 3328x1248, 720x1280, 720x1440, 800x1280, 832x1248, 864x1152, 896x1120. ideogram-v4.5-edit 默认为 auto,保留源图尺寸。
  • 使用蒙版或 edit_precision=high 时,需要 auto 或省略尺寸。
  • 比例预设和自定义 WIDTHxHEIGHT 尺寸仅适用于无蒙版的常规编辑。
  • 自定义编辑尺寸的每个维度至少为 256 且能被 32 整除,总像素数不超过 4,194,304,宽高比不超过 6:1。

示例

生成图像

编辑图像

高精度蒙版编辑

注意事项

  • ideogram-v4.5-edit 要求 image_urls 中恰好有一张主图。
  • 通过标准的任务状态 API 查询状态。
  • 成功响应返回 files,其中生成的图像为 file_type: image。

授权

Authorization
string
header
必填

所有 API 接口都需要 Bearer Token 认证。

创建 API Key:登录 PoYo,进入 仪表盘 → API 密钥(poyo.ai/zh/dashboard/api-key),点击创建 Key。

在请求头中添加:

请求体

application/json
model
enum<string>
必填

文生图使用 ideogram-v4.5,图像编辑使用 ideogram-v4.5-edit。

可用选项:
ideogram-v4.5,
ideogram-v4.5-edit
input
object
必填
callback_url
string<uri>

可选的完成或失败回调 URL。

响应

任务已受理;请查询任务获取最终文件。

code
enum<integer>
必填

业务状态码。200 表示成功,其他值都表示请求失败。请务必检查这个字段:部分参数校验错误会以 HTTP 200 返回,响应体里的 code 为 400。

  • 200:成功
  • 400:请求参数无效
  • 401:API Key 缺失或无效
  • 402:积分不足
  • 403:没有权限
  • 404:资源不存在
  • 408:请求超时
  • 429:请求频率超限
  • 500:服务器内部错误
  • 502:上游服务错误
  • 503:服务暂不可用

详见错误码。

可用选项:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
示例:

200

data
object
必填