> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poyo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ideogram Vector 1.0

> Generate SVG vector graphics from a prompt, with up to five reference images, or convert one image into an SVG.

> [!TIP]
>
> 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](https://docs.poyo.ai/api-manual/task-management/status.md) 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.


## OpenAPI

````yaml api-manual/image-series/ideogram-vector-1-0.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: PoYo AI - Ideogram Vector 1.0 API
  description: >-
    Generate SVG vector graphics from a prompt, with up to five reference
    images, or convert one image into an SVG.
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Ideogram Vector 1.0
      summary: Submit an Ideogram Vector 1.0 task
      operationId: submitIdeogramVector10Task
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              text-to-vector:
                summary: Generate an SVG from a prompt
                value:
                  model: ideogram-vector-1.0/text-to-vector
                  input:
                    prompt: A playful cat logo with bold outlines and flat colors
              text-with-references:
                summary: Generate an SVG with reference images
                value:
                  model: ideogram-vector-1.0/text-to-vector
                  input:
                    prompt: A flat mountain travel poster
                    image_urls:
                      - https://example.com/style.png
                    quality: high
                    size: '16:9'
                    'n': 2
              image-to-vector:
                summary: Convert one image into an SVG
                value:
                  model: ideogram-vector-1.0/image-to-vector
                  input:
                    image_urls:
                      - https://example.com/source.png
                    mode: simple
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      additionalProperties: false
      properties:
        model:
          type: string
          enum:
            - ideogram-vector-1.0/text-to-vector
            - ideogram-vector-1.0/image-to-vector
          description: >-
            Public model identifier. Use text-to-vector to generate from a
            prompt, or image-to-vector to convert one image.
        callback_url:
          type: string
          format: uri
          description: Webhook URL for finished or failed task notifications.
        input:
          type: object
          additionalProperties: false
          description: >-
            Text to vector requires prompt. Image to vector requires exactly one
            image URL. On text to vector, image_urls are optional reference
            images.
          properties:
            prompt:
              type: string
              minLength: 1
              maxLength: 9500
              description: >-
                Required for ideogram-vector-1.0/text-to-vector. Describe the
                SVG in 1-9500 characters containing non-whitespace text. Not
                accepted for image to vector.
            image_urls:
              description: >-
                ideogram-vector-1.0/text-to-vector: optional. Supply 1-5
                publicly accessible HTTP(S) reference images. The first URL is
                the primary reference. JPEG, PNG, or WebP, up to 10 MB each.
                Omit this field when there is no reference image.


                ideogram-vector-1.0/image-to-vector: required. Supply exactly
                one publicly accessible HTTP(S) image URL to convert. JPEG, PNG,
                or WebP, up to 50 MB.
              oneOf:
                - title: ideogram-vector-1.0/text-to-vector
                  type: array
                  minItems: 1
                  maxItems: 5
                  items:
                    type: string
                    format: uri
                  description: >-
                    Optional for ideogram-vector-1.0/text-to-vector. Supply 1-5
                    publicly accessible HTTP(S) reference images. The first URL
                    is the primary reference. JPEG, PNG, or WebP, up to 10 MB
                    each. Omit this field when there is no reference image.
                - title: ideogram-vector-1.0/image-to-vector
                  type: array
                  minItems: 1
                  maxItems: 1
                  items:
                    type: string
                    format: uri
                  description: >-
                    Required for ideogram-vector-1.0/image-to-vector. Supply
                    exactly one publicly accessible HTTP(S) image URL to
                    convert. JPEG, PNG, or WebP, up to 50 MB.
            quality:
              type: string
              enum:
                - low
                - medium
                - high
              default: medium
              description: >-
                Text to vector quality. Defaults to medium. Not accepted for
                image to vector.
            'n':
              type: integer
              minimum: 1
              maximum: 8
              default: 1
              description: >-
                Text to vector output count, from 1 through 8. Defaults to 1.
                Not accepted for image to vector.
            size:
              type: string
              enum:
                - 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'
              default: auto
              description: >-
                Text to vector aspect ratio. Defaults to auto. Not accepted for
                image to vector.
            mode:
              type: string
              enum:
                - default
                - simple
              default: default
              description: >-
                Image to vector only. default keeps finer detail. simple uses
                fewer shapes. Defaults to default. Not accepted for text to
                vector.
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
          example: 200
          description: >-
            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](/api-manual/error-codes) for details.
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1792468800-example
            status:
              type: string
              enum:
                - not_started
                - running
                - finished
                - failed
              example: not_started
              description: >-
                Task status. Always `not_started` right after submission. Use
                [Query Task Status](/api-manual/task-management/status) or
                `callback_url` to get later states.


                - `not_started`: Queued, waiting to be processed

                - `running`: Being generated

                - `finished`: Completed; results are in `files` or `output`

                - `failed`: Failed; details are in `error_message`
            created_time:
              type: string
              format: date-time
              example: '2026-11-03T06:00:00'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
            type:
              type: string
              example: invalid_request_error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        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](https://poyo.ai/dashboard/api-key), and
        click to create a key.


        Add it to the request header:


        ```

        Authorization: Bearer PoYo_API_KEY

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.