Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the response result through the unified Query Task Status endpoint.
Ideogram Vector 1.0 creates editable SVG graphics from a text prompt, or converts one existing image into an SVG. Text generation can follow up to five reference images.

Models

  • ideogram-vector-1.0/text-to-vector — Generate SVGs from a prompt, with optional reference images
  • ideogram-vector-1.0/image-to-vector — Convert exactly one image into an SVG

Features

  • Generate 1–8 SVGs from a prompt, with quality and aspect-ratio controls.
  • Guide text generation with 1–5 reference images in image_urls. The first image is the primary reference.
  • Convert exactly one JPEG, PNG, or WebP image into an SVG, with a detail mode or a simpler shape mode.

Required parameters

  • prompt (string): Required for ideogram-vector-1.0/text-to-vector. Use 1–9500 characters containing non-whitespace text.
  • image_urls (array of strings): Required for ideogram-vector-1.0/image-to-vector. Exactly one publicly accessible HTTP(S) image URL to convert. JPEG, PNG, or WebP, up to 50 MB.

Optional parameters

  • image_urls (array of strings): Optional for ideogram-vector-1.0/text-to-vector. 1–5 publicly accessible HTTP(S) reference images. JPEG, PNG, or WebP, up to 10 MB each. The first URL is the primary reference. Omit this field when there is no reference image.
  • quality (string): Text to vector only. low, medium, or high. Defaults to medium.
  • n (integer): Text to vector only. Number of SVGs, from 1 through 8. Defaults to 1.
  • size (string): Text to vector only. Aspect ratio. Defaults to auto.
  • mode (string): Image to vector only. default keeps finer detail. simple uses fewer shapes. Defaults to default.
Image fields also accept image data URIs.

Size

Text to vector accepts 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, and 4:1. The default is auto. Image to vector does not accept size.

Output

A finished task returns SVG files. Each file uses file_type: image.

Examples

Text to vector, text to vector with reference images, and single-image conversion are included in the OpenAPI examples.

Notes

  • Choose the model ID for the task. Text to vector does not accept mode. Image to vector does not accept prompt, quality, n, or size.
  • On text to vector, image_urls are reference images. On image to vector, image_urls is the one image to convert.
  • Keep generation parameters inside input. callback_url belongs at the top level of the request.

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication.

Create an API key: sign in to PoYo, open Dashboard → API Key at poyo.ai/dashboard/api-key, and click to create a key.

Add it to the request header:

Body

application/json
model
enum<string>
required

Public model identifier. Use text-to-vector to generate from a prompt, or image-to-vector to convert one image.

Available options:
ideogram-vector-1.0/text-to-vector,
ideogram-vector-1.0/image-to-vector
input
object
required

Text to vector requires prompt. Image to vector requires exactly one image URL. On text to vector, image_urls are optional reference images.

callback_url
string<uri>

Webhook URL for finished or failed task notifications.

Response

Task submitted successfully

code
enum<integer>
required

Business status code. 200 means success; any other value means the request failed. Always check this field: some validation errors return HTTP 200 with code: 400 in the body.

  • 200: Success
  • 400: Invalid request parameters
  • 401: Missing or invalid API key
  • 402: Insufficient credits
  • 403: Permission denied
  • 404: Resource not found
  • 408: Request timeout
  • 429: Rate limit exceeded
  • 500: Internal server error
  • 502: Upstream service error
  • 503: Service unavailable

See Error Codes for details.

Available options:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
Example:

200

data
object
required