Skip to navigation
Vectors

Vectorizer

Converts an image to SVG asynchronously.

Authentication

Api-Keystring

API key for access control. Use in the header with the name “Api-Key”

Query parameters

dry_runbooleanOptionalDefaults to false

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Request

This endpoint expects a multipart form containing an optional file.
imagefileOptional

JPEG, PNG or WEBP source; at most 50 MB. Multipart only.

image_asset_identifierobjectOptional
An identifier for an ideogram asset.
modeenumOptionalDefaults to default

Simple draws fewer, simpler shapes; default preserves more fine detail.

Allowed values:
groupbooleanOptionalDefaults to false
Request grouping of shapes into layers. Grouping is not yet available.
privatebooleanOptional
Outputs are private by default. Enterprise outputs are always private.
target_collection_idstringOptional

URL-safe base64 ID of a writable destination collection.

webhook_urlstringOptionalformat: "uri"<=2048 characters

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

Response

Conversion accepted; dry runs return the shared PriceQuote response.

generation_idstring

URL-safe base64 generation ID.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error