Docs

Running a model

IdeogramText to image

Ideogram Vector 1.0

Scalable, editable SVG artwork from text prompts or existing images

POSTauray-serverless/ideogram/vector-1-0
openapi.jsonllms.txt

One of Auray's catalogue models: the same key, the same credits, the same job lifecycle as every other address.

Its request shape is published below. Whether it runs right now is GET /v1/catalogue's word, with no key needed: its addresses say connected for an address that runs, and a submit to any other is refused before anything is charged — described answers 501 model_not_connected, paused 503 model_disabled.

Category text-to-image · Scope image:write (or external:write on an older key) · Price Quoted in credits when you submit: the submit's answer carries it as credits_quoted, and credits_charged says what has been taken.

#What it can do

  • t2i — Text → Image
  • img-refs — Edit & combine: up to 5 pictures
  • vectorize — Vectorize: 1 source file
  • Aspect ratios: 1:1, 1:2, 16:9, 2:1, 2:3, 2048:683, 3:2, 3:4, 4:3, 4:5, 5:4, 5:8, 683:2048, 8:5, 9:16
  • Resolutions: 2K
  • Prompt: up to 9,500 characters
  • Sound: makes no sound of its own
  • Priced by: call (the whole rule is under Price)

Find the addresses that do any of these with GET /v1/models?operation=<id>; the openapi.json carries them as data under x-auray-capability.

#Input

FieldTypeRequiredDefaultDescription
inputsobjectno—
inputs.imagestringno—Image input (an http(s) URL; upload a local file first and send its read URL). Converted to SVG at its own dimensions, scaled down to 2048 pixels on the long side when larger. A URL.
inputs.referenceImagesstring[]no—List of reference images (an http(s) URL; upload a local file first and send its read URL). The first image sets the aspect ratio when width and height are omitted. Documented range: 1 to 5.
positivePromptstringno—Text prompt describing elements to include in the generated output. Documented range: 1 to 9,500 characters.
widthintegerno—Width of the generated media in pixels.
heightintegerno—Height of the generated media in pixels.
settingsobjectno—
settings.modestringno—Level of detail in the conversion. One of "simple", "detailed", "auto".
settings.qualitystringno"medium"Rendering quality. One of "low", "medium", "high".
outputTypestringno"URL"Image output type. One of "URL".
outputFormatstringno"SVG"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - `JPG`: Best for photorealistic images with smaller file sizes (no transparency). - `PNG`: Lossless compression, supports high quality and transparency (alpha channel). - `WEBP`: Modern format providing superior compression and transparency support. - `MP4`: Widely supported video container (H.264), recommended for general use. - `WEBM`: Optimized for web delivery. - `MOV`: QuickTime format, common in professional workflows (Apple ecosystem). - `GIF`: Animated image format (no audio), suitable for short loops or previews. - `MP3`: Compressed audio, smaller file size. - `WAV`: Uncompressed, high-quality audio. - `FLAC`: Lossless compression. - `OGG`: Open-source compressed audio format (Vorbis codec). - `SVG`: Scalable Vector Graphics. - `TIFF`: High-quality output supporting layers. - `GLB`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > **Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency. One of "SVG".
idempotency_keystringno—Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. Idempotency-Key: as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on auray.run, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one. 1 to 64 characters.

#Rules

Across fields, as the model's documentation states them. Each is judged before anything is charged — warned with a Deprecation header until enforcement starts — and listed as JSON Schema under x-auray-rules in the openapi.json.

  • Send height whenever width is sent. Send width whenever height is sent.
  • Do not send positivePrompt together with settings.mode.
  • When inputs.image is sent, do not send a request where inputs.referenceImages is sent, or where settings.quality is sent, or where width is sent, or where height is sent.
  • When width is sent or height is sent, width and height must be one of these: 2K (~1:3): width 683, height 2048; 2K (1:2): width 1024, height 2048; 2K (9:16): width 1152, height 2048; 2K (10:16): width 1280, height 2048; 2K (~2:3): width 1365, height 2048; 2K (3:4): width 1536, height 2048; 2K (~4:5): width 1638, height 2048; 2K (1:1): width 2048, height 2048; 2K (~5:4): width 2048, height 1638; 2K (4:3): width 2048, height 1536; 2K (~3:2): width 2048, height 1365; 2K (16:10): width 2048, height 1280; and 3 more (15 in all).
  • Send exactly one of positivePrompt or inputs.image.

#Example

curl -X POST https://queue.auray.run/auray-serverless/ideogram/vector-1-0 \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left"
}'

The same body on https://auray.run runs synchronously and answers the result — unless it usually takes longer than a run may hold its connection, which is refused 400 model_not_synchronous before anything is charged. Options — ?webhook=, ?wait=, priority and timeout headers — are on Submit a request.

#Machine contracts

  • openapi.json — this page as an OpenAPI 3.1 document, public.
  • llms.txt — the same, written for an agent.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close