Ideogram Vector 1 API
Text-to-SVG logos, icons, and editable vector illustrations.
POST /v2/ideogram-vector-1 · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "ideogram-vector-1",
9 prompt="A circular enamel-badge logo for a cycling club. A side-profile road bicycle sits centred over a smooth teal-to-indigo gradient disc, its two wheels drawn as thin concentric rings. The words 'GASWORKS CYCLING CLUB' curve along the top rim in bold condensed sans-serif, and 'EST. 1974' sits on a small ribbon across the bottom. Flat vector shapes, cream and amber accents, clean white background.",
10 images=[],
11 quality="high",
12 aspect_ratio="1x1",
13 seed=734512,
14)
15print(result["status"]) # COMPLETED
16print(result.get("output")) # model output (e.g. media URL)
17print(result["metrics"]["inference_time"]) # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient() # reads SEGMIND_API_KEY
23payload = {
24 "prompt": "A circular enamel-badge logo for a cycling club. A side-profile road bicycle sits centred over a smooth teal-to-indigo gradient disc, its two wheels drawn as thin concentric rings. The words 'GASWORKS CYCLING CLUB' curve along the top rim in bold condensed sans-serif, and 'EST. 1974' sits on a small ribbon across the bottom. Flat vector shapes, cream and amber accents, clean white background.",
25 "images": [],
26 "quality": "high",
27 "aspect_ratio": "1x1",
28 "seed": 734512,
29}
30job = client.submit_async("ideogram-vector-1", **payload)
31print(job.request_id) # available immediately
32try:
33 result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35 print("still running:", e.request_id)
36except InferenceFailed as e:
37 print("failed:", e.detail) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "ideogram-vector-1",
9 prompt="A circular enamel-badge logo for a cycling club. A side-profile road bicycle sits centred over a smooth teal-to-indigo gradient disc, its two wheels drawn as thin concentric rings. The words 'GASWORKS CYCLING CLUB' curve along the top rim in bold condensed sans-serif, and 'EST. 1974' sits on a small ribbon across the bottom. Flat vector shapes, cream and amber accents, clean white background.",
10 images=[],
11 quality="high",
12 aspect_ratio="1x1",
13 seed=734512,
14)
15print(result["status"]) # COMPLETED
16print(result.get("output")) # model output (e.g. media URL)
17print(result["metrics"]["inference_time"]) # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient() # reads SEGMIND_API_KEY
23payload = {
24 "prompt": "A circular enamel-badge logo for a cycling club. A side-profile road bicycle sits centred over a smooth teal-to-indigo gradient disc, its two wheels drawn as thin concentric rings. The words 'GASWORKS CYCLING CLUB' curve along the top rim in bold condensed sans-serif, and 'EST. 1974' sits on a small ribbon across the bottom. Flat vector shapes, cream and amber accents, clean white background.",
25 "images": [],
26 "quality": "high",
27 "aspect_ratio": "1x1",
28 "seed": 734512,
29}
30job = client.submit_async("ideogram-vector-1", **payload)
31print(job.request_id) # available immediately
32try:
33 result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35 print("still running:", e.request_id)
36except InferenceFailed as e:
37 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/ideogram-vector-1Parameters
promptrequiredstringDescribe the vector artwork: subject, style (flat, line art, badge), colours and any exact text in quotes. Up to 9500 characters.
"Flat minimal logo of a fox head, two colours, clean geometric shapes, white background"aspect_ratiooptionalstringCanvas shape of the SVG (18 ratios). Use 1x1 for logos and badges, 16x9 or 9x16 for posters; auto lets the model choose.
"1x1""auto""1x1""16x9""9x16""4x3""3x4""3x2""2x3""5x4""4x5"+8 moreimagesoptionalstring[]Optional, up to 5 images (JPEG, PNG or WebP, max 25MB each); the first is the primary source to transform, the rest guide style. Leave empty for pure text-to-SVG.
[]qualityoptionalstringRender and price tier: low for drafts, medium for most work, high for intricate detail. High costs more only when images are attached.
"medium""low""medium""high"seedoptionalintegerInteger 0-2147483647 for reproducible output. Set to repeat an exact result; omit for variety.
Response Type
Returns: Text/JSON
Asynchronous requests (v2)
Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.
- 1
POST /v2/ideogram-vector-1Submit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- A FAILED request is served as HTTP 422 — the body still carries the error detail.
- An unknown or expired request_id returns HTTP 404.
- Results are retained for 1 hour, then expire.
- Content / RAI blocks surface as FAILED, not a separate state.
- Track completion by polling the status endpoint.
Common Error Codes
The API returns standard HTTP status codes. Detailed error messages are provided in the response body.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out