## Basic model info - Model name: ideogram/ideogram ideogram-vector-1 - Model description: Ideogram Vector 1.0 is Ideogram's first vector model: it generates clean, editable SVGs with smooth gradients and sharp typography from a text prompt, optionally guided by up to 5 reference images, or converts an existing image into a scalable SVG. text-to-vector $0.13 / $0.16 / $0.20 per SVG at low / medium / high quality ($0.32 high with references); image-to-vector $0.10 per SVG. - Endpoint name: text-to-vector ## Model schema The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/ideogram/ideogram-vector-1/latest.json) ### Model input schema The model input schema is: ```json { "description": "Input model for Ideogram Vector text-to-vector (editable SVG).", "properties": { "prompt": { "description": "Description of the SVG to generate, e.g. a logo, icon or illustration; text in quotes is rendered as typography", "maxLength": 9500, "minLength": 1, "title": "Prompt", "type": "string", "x-sr-order": 201 }, "aspect_ratio": { "default": "auto", "description": "Aspect ratio of the SVG canvas. Does not change the price", "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" ], "title": "Aspect Ratio", "type": "string", "x-sr-order": 402 }, "seed": { "anyOf": [ { "maximum": 2147483647, "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Seed for reproducible generation", "title": "Seed", "x-sr-order": 501 }, "number_of_images": { "default": 1, "description": "Number of SVGs to generate (1-8), billed per SVG", "maximum": 8, "minimum": 1, "title": "Number Of Images", "type": "integer", "x-sr-order": 403 }, "quality": { "default": "medium", "description": "Generation quality: $0.13 low, $0.16 medium, $0.20 high per SVG ($0.32 high with reference images)", "enum": [ "low", "medium", "high" ], "title": "Quality", "type": "string", "x-sr-order": 401 }, "reference_images": { "anyOf": [ { "items": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "string" } ] }, "maxItems": 5, "type": "array" }, { "type": "null" } ], "description": "Up to 5 reference images (public URLs) to guide style or content; the first is the primary source. Raises the high-quality price", "title": "Reference Images", "x-sr-order": 301 } }, "required": [ "prompt" ], "title": "TextToVectorInput", "type": "object" } ``` ### Model output schema The model output schema is: ```json { "anyOf": [ { "description": "Generated SVG files plus the final USD amount for billing.", "properties": { "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Seed used for generation, if provided", "title": "Seed" }, "images": { "items": { "properties": { "content_type": { "description": "The mime type of the file.", "title": "Content Type", "type": "string" }, "file_name": { "description": "The name of the file. It will be auto-generated if not provided.", "title": "File Name", "type": "string" }, "file_size": { "description": "The size of the file in bytes.", "title": "File Size", "type": "integer" }, "url": { "description": "The URL where the file can be downloaded from.", "title": "Url", "type": "string" } }, "required": [ "content_type", "file_name", "file_size", "url" ], "title": "SunraFile", "type": "object" }, "title": "Images", "type": "array" }, "units": { "description": "Final billable amount in USD (per-SVG rate x returned SVG count)", "title": "Units", "type": "number" } }, "required": [ "images", "units" ], "title": "TextToVectorOutput", "type": "object" }, { "description": "The vectorized SVG file.", "properties": { "images": { "items": { "properties": { "content_type": { "description": "The mime type of the file.", "title": "Content Type", "type": "string" }, "file_name": { "description": "The name of the file. It will be auto-generated if not provided.", "title": "File Name", "type": "string" }, "file_size": { "description": "The size of the file in bytes.", "title": "File Size", "type": "integer" }, "url": { "description": "The URL where the file can be downloaded from.", "title": "Url", "type": "string" } }, "required": [ "content_type", "file_name", "file_size", "url" ], "title": "SunraFile", "type": "object" }, "title": "Images", "type": "array" } }, "required": [ "images" ], "title": "ImageToVectorOutput", "type": "object" } ], "title": "Response Get Request Result Requests Request Id Get" } ``` ## Example inputs and outputs Use the following example inputs and outputs to understand the model. ### Input example ```json { "prompt": "", "aspect_ratio": "auto", "seed": null, "number_of_images": 1, "quality": "medium", "reference_images": null } ``` ### Output example ```json { } ``` ## Model code examples ### JavaScript ```javascript import { sunra } from "@sunra/client"; const result = await sunra.subscribe("ideogram/ideogram-vector-1/text-to-vector", { input: { prompt: '', reference_images: null, quality: 'medium', aspect_ratio: 'auto', number_of_images: 1, seed: null }, logs: true, onQueueUpdate: (update) => { console.log(`Status Update: ${update.status}, Request ID: ${update.request_id}`); }, }); console.log(result.data); console.log(result.requestId); ``` ### Python ```python import sunra_client result = sunra_client.subscribe( "ideogram/ideogram-vector-1/text-to-vector", arguments={ "prompt": "", "reference_images": None, "quality": "medium", "aspect_ratio": "auto", "number_of_images": 1, "seed": None }, with_logs=True, on_enqueue=print, on_queue_update=print, ) print(result) ``` ### Java ```java import ai.sunra.client.*; import java.util.Map; import com.google.gson.JsonObject; var client = SunraClient.withEnvCredentials(); var response = client.subscribe( "ideogram/ideogram-vector-1/text-to-vector", SubscribeOptions.builder() .input(Map.of( "prompt", "", "reference_images", null, "quality", "medium", "aspect_ratio", "auto", "number_of_images", 1, "seed", null)) .resultType(JsonObject.class) .onQueueUpdate(update -> System.out.printf( "\nStatus Update: %s, Request ID: %s%n", update.getStatus(), update.getRequestId() )) .logs(true) .build() ); System.out.println("Completed!"); System.out.println(response.getData()); ``` ### Kotlin ```kotlin import ai.sunra.client.kt.* import com.google.gson.JsonObject val client = createSunraClient() val response = client.subscribe( endpointId = "ideogram/ideogram-vector-1/text-to-vector", input = mapOf( "prompt" to "", "reference_images" to null, "quality" to "medium", "aspect_ratio" to "auto", "number_of_images" to 1, "seed" to null), options = ai.sunra.client.kt.SubscribeOptions(logs = true), onUpdate = { update -> println("\nStatus Update: ${update.status}, Request ID: ${update.requestId}") } ) println("Completed!") println(response.data) ``` ### Curl ```bash curl --request POST \ --url https://api.sunra.ai/v1/queue/ideogram/ideogram-vector-1/text-to-vector \ --header "Authorization: Key $SUNRA_KEY" \ --header "Content-Type: application/json" \ --data '{"prompt":"","reference_images":null,"quality":"medium","aspect_ratio":"auto","number_of_images":1,"seed":null}' ``` ## Model readme >