Ideogram Vector 1.0
Ideogram Vector 1.0 is Ideogram's vector model, generating SVG artwork from text prompts, optionally guided by up to five reference images, and converting existing images into SVG. Each shape stays editable, so colors can be matched to a brand and individual elements refined in a vector editor. It suits logos, typography, illustrations, print designs, and labels or stickers.
API Options
Platform-level options for task execution and delivery.
taskType
stringrequiredvalue: vectorizeIdentifier for the type of task being performed.
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
outputType
stringdefault: URLImage output type.
Allowed values3 values
outputFormat
stringdefault: SVGSpecifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.
- `SVG`: Scalable Vector Graphics.
Allowed values1 value
webhookURL
stringuriWebhook URL that receives JSON responses via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.
Learn more1 resource
- WebhooksPLATFORM
- Webhooks
deliveryMethod
stringdefault: syncDetermines how the API delivers task results.
Allowed values2 values
- Returns results directly in the API response. Over HTTP, a task still running after 120 seconds continues as an async task and comes back with status 'processing'. Poll for its results using getResponse.
- Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse.
Learn more1 resource
- Task PollingPLATFORM
uploadEndpoint
stringuriSpecifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.
Common use cases:
- Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
- CDN integration: Upload to content delivery networks for immediate distribution.
// S3 presigned URL for secure upload https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600 // Google Cloud Storage presigned URL https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789 // Custom storage endpoint https://storage.example.com/uploads/generated-image.jpgThe content data will be sent as the request body to the specified URL when generation is complete.
ttl
integermin: 60Time-to-live (TTL) in seconds for generated content. Only applies when
outputTypeisURL.
includeCost
booleanInclude task cost in the response.
routing
objectModel router options. Only read when
modelisauto, and never sent to the model.Properties3 properties
routing»preferencespreferences
objectRelative importance of each dimension when models are compared. Weights, not thresholds.
Properties3 properties
routing»preferences»qualityquality
integermin: 0max: 5Importance of one dimension.
0leaves it out of the decision.
routing»preferences»speedspeed
integermin: 0max: 5Importance of one dimension.
0leaves it out of the decision.
routing»preferences»costcost
integermin: 0max: 5Importance of one dimension.
0leaves it out of the decision.
routing»maxPricemaxPrice
floatmin: 0Upper bound on what this request may cost, in USD. A model whose cost cannot be bounded is not chosen.
routing»requirementsrequirements
stringmax: 3000Conditions the result has to meet, in plain words, such as a style or a feature. A model that cannot meet them is not chosen. Output size is set with width and height rather than described here.
Inputs
Input resources for the task (images, audio, etc). These must be nested inside the inputs object.
inputs object.inputs»imageimage
string2 limitsImage input (UUID, URL, Data URI, or Base64). Converted to SVG at its own dimensions, scaled down to 2048 pixels on the long side when larger.
inputs»referenceImagesreferenceImages
array of stringsmin items: 1max items: 53 limitsList of reference images (UUID, URL, Data URI, or Base64). The first image sets the aspect ratio when
widthandheightare omitted.
Core Parameters
Primary parameters that define the task output.
model
stringrequiredvalue: ideogram:vector@1.0Send
autoinstead of an AIR identifier to have the model router choose the model for this task. The rest of the request is unchanged, every value you send is kept, and only the parameters you leave out are filled in. See Model Router.Learn more3 resources
positivePrompt
stringmin: 1max: 9500Text prompt describing elements to include in the generated output.
Learn more1 resource
- PromptsLEARN
- Prompts
width
integerpaired with heightWidth of the generated media in pixels.
Learn more2 resources
height
integerpaired with widthHeight of the generated media in pixels.
Learn more2 resources
Settings
Technical parameters to fine-tune the inference process. These must be nested inside the settings object.
settings object.