跳转到主要内容
POST
  1. 提交后会返回 task_id。如果提供了 callback_url,当任务状态变为 finished 或 failed 时,系统会向 callback_url 发送 POST 请求。
  2. 无论是否提供 callback_url,都可以通过统一的查询任务状态接口获取结果。
Ideogram Vector 1.0 可以根据提示词生成可编辑的 SVG,或把一张已有图片转换成 SVG。文生矢量最多可以使用五张参考图。

模型

  • ideogram-vector-1.0/text-to-vector — 根据提示词生成 SVG,可选参考图
  • ideogram-vector-1.0/image-to-vector — 把恰好一张图片转换成 SVG

功能

  • 根据提示词生成 1–8 张 SVG,可控制质量和宽高比。
  • 文生矢量可在 image_urls 中带 1–5 张参考图。第一张是主参考图。
  • 把恰好一张 JPEG、PNG 或 WebP 图片转换成 SVG,可选保留细节或使用更少图形。

必填参数

  • prompt (string):ideogram-vector-1.0/text-to-vector 必填。使用 1–9500 个字符,且须包含非空白文本。
  • image_urls (array of strings):ideogram-vector-1.0/image-to-vector 必填。恰好一个可公开访问的 HTTP(S) 图片 URL,用于转换成 SVG。支持 JPEG、PNG 或 WebP,最大 50 MB。

可选参数

  • image_urls (array of strings):ideogram-vector-1.0/text-to-vector 可选。1–5 个可公开访问的 HTTP(S) 参考图。支持 JPEG、PNG 或 WebP,每张最大 10 MB。第一个 URL 是主参考图。没有参考图时不要传这个字段。
  • quality (string):仅文生矢量。low、medium 或 high。默认为 medium。
  • n (integer):仅文生矢量。SVG 数量,1 到 8。默认为 1。
  • size (string):仅文生矢量。宽高比。默认为 auto。
  • mode (string):仅图片转矢量。default 保留更多细节。simple 使用更少图形。默认为 default。
图片字段也接受图片 data URI。

尺寸

文生矢量接受 auto、1:1、1:4、1:3、1:2、9:16、10:16、2:3、3:4、4:5、5:4、4:3、3:2、16:10、16:9、2:1、3:1 和 4:1。默认为 auto。 图片转矢量不接受 size。

输出

完成的任务返回 SVG 文件。每个文件的 file_type 为 image。

示例

OpenAPI 示例包含文生矢量、带参考图的文生矢量,以及单图转矢量。

注意事项

  • 按任务选择模型 ID。文生矢量不接受 mode。图片转矢量不接受 prompt、quality、n 或 size。
  • 文生矢量里的 image_urls 是参考图。图片转矢量里的 image_urls 是要转换的那一张图片。
  • 生成参数放在 input 内。callback_url 属于请求顶层。

授权

Authorization
string
header
必填

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

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

在请求头中添加:

请求体

application/json
model
enum<string>
必填

公开模型标识。文生矢量使用 text-to-vector,单图转矢量使用 image-to-vector。

可用选项:
ideogram-vector-1.0/text-to-vector,
ideogram-vector-1.0/image-to-vector
input
object
必填

文生矢量必填 prompt。图片转矢量必填恰好一个图片 URL。文生矢量里的 image_urls 是可选参考图。

callback_url
string<uri>

任务完成或失败时接收通知的 Webhook 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
必填