Running a model
IdeogramImage to imageIdeogram 3.0 Remix
Remix Ideogram 3.0 images with fresh styles and palettes
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 image-to-image · Scope image:write (or external:write on an older key) · Price Credits per megapixel (counted as width*height): 7.9068. From 1.0118 to 2.3593 megapixels a request. Priced up to height 1536, width 1536; past that a request is refused before any charge. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote. The submit's answer carries the quote as credits_quoted, and credits_charged says what has been taken.
#Input
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
inputs | object | yes | — | |
inputs.referenceImages | string[] | yes | — | List of reference images (an http(s) URL; upload a local file first and send its read URL). Documented range: 1 to 1. |
positivePrompt | string | yes | — | Text prompt describing elements to include in the generated output. Documented range: 1 to 2,000 characters. |
negativePrompt | string | no | — | Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 1 to 2,000 characters. |
width | integer | yes | 1024 | Width of the generated media in pixels. |
height | integer | yes | 1024 | Height of the generated media in pixels. |
providerSettings | object | no | — | |
providerSettings.ideogram | object | no | — | |
providerSettings.ideogram.characterReferenceImages | string[] | no | — | Character reference images to preserve consistent facial and body traits across generations. Documented range: 1 to 1. |
providerSettings.ideogram.characterReferenceImagesMask | string[] | no | — | Mask images for character reference images. Must match the number of character reference images. Documented range: 1 to 1. |
providerSettings.ideogram.magicPrompt | string | no | "AUTO" | Automatic prompt enhancement. One of "AUTO", "ON", "OFF". |
providerSettings.ideogram.renderingSpeed | string | no | "DEFAULT" | Generation speed/quality tradeoff. One of "TURBO", "DEFAULT", "QUALITY". |
providerSettings.ideogram.stylePreset | string | no | — | Artistic style preset. One of "80S_ILLUSTRATION", "90S_NOSTALGIA", "ABSTRACT_ORGANIC", "ANALOG_NOSTALGIA", "ART_BRUT", "ART_DECO", "ART_POSTER", "AURA", "AVANT_GARDE", "BAUHAUS", "BLUEPRINT", "BLURRY_MOTION", "BRIGHT_ART", "C4D_CARTOON", "CHILDRENS_BOOK", "COLLAGE", "COLORING_BOOK_I", "COLORING_BOOK_II", "CUBISM", "DARK_AURA", "DOODLE", "DOUBLE_EXPOSURE", "DRAMATIC_CINEMA", "EDITORIAL", "EMOTIONAL_MINIMAL", "ETHEREAL_PARTY", "EXPIRED_FILM", "FLAT_ART", "FLAT_VECTOR", "FOREST_REVERIE", "GEO_MINIMALIST", "GLASS_PRISM", "GOLDEN_HOUR", "GRAFFITI_I", "GRAFFITI_II", "HALFTONE_PRINT", "HIGH_CONTRAST", "HIPPIE_ERA", "ICONIC", "JAPANDI_FUSION", "JAZZY", "LONG_EXPOSURE", "MAGAZINE_EDITORIAL", "MINIMAL_ILLUSTRATION", "MIXED_MEDIA", "MONOCHROME", "NIGHTLIFE", "OIL_PAINTING", "OLD_CARTOONS", "PAINT_GESTURE", "POP_ART", "RETRO_ETCHING", "RIVIERA_POP", "SPOTLIGHT_80S", "STYLIZED_RED", "SURREAL_COLLAGE", "TRAVEL_POSTER", "VINTAGE_GEO", "VINTAGE_POSTER", "WATERCOLOR", "WEIRD", "WOODBLOCK_PRINT". |
providerSettings.ideogram.styleType | string | no | "AUTO" | Visual style and rendering approach. One of "AUTO", "GENERAL", "REALISTIC", "DESIGN", "FICTION". |
outputType | string | no | "URL" | Image output type. One of "URL". |
outputFormat | string | no | "JPG" | 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 "JPG", "PNG", "WEBP". |
outputQuality | integer | no | 95 | Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99. |
safety | object | no | — | |
safety.checkContent | boolean | no | — | Enable or disable content safety checking. Increases total generation time. Always on: a false is sent as true. |
advancedFeatures | object | no | — | |
advancedFeatures.watermark | object | no | — | |
advancedFeatures.watermark.text | string | no | — | Watermark text. Documented range: 2 to 32 characters. |
advancedFeatures.watermark.image | string | no | — | Watermark image (an http(s) URL; upload a local file first and send its read URL). A URL. |
advancedFeatures.watermark.displayPosition | string | no | — | Watermark position. One of "top-left", "top-center", "top-right", "center-left", "center-center", "center-right", "bottom-left", "bottom-center", "bottom-right", "tiled". |
advancedFeatures.watermark.opacity | number | no | — | Watermark opacity. Documented range: 0.1 to 1. |
advancedFeatures.watermark.fontColor | string | no | — | Text color in hex format. |
advancedFeatures.watermark.bgColor | string | no | — | Background color in hex format. |
idempotency_key | string | no | — | 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
heightwheneverwidthis sent. Sendwidthwheneverheightis sent. - When
widthis sent orheightis sent,widthandheightmust be one of these: 1K (3:1): width 1536, height 512; 1K (~21:9): width 1536, height 576; 1K (~21:9): width 1472, height 576; 1K (~21:9): width 1408, height 576; 1K (~21:9): width 1536, height 640; 1K (~21:9): width 1472, height 640; 1K (~21:9): width 1408, height 640; 1K (~2:1): width 1344, height 640; 1K (~2:1): width 1472, height 704; 1K (2:1): width 1408, height 704; 1K (~2:1): width 1344, height 704; 1K (~16:9): width 1280, height 704; and 57 more (69 in all). - When
providerSettings.ideogram.characterReferenceImagesMaskis sent,providerSettings.ideogram.characterReferenceImagesis required. - When
providerSettings.ideogram.characterReferenceImagesis sent,providerSettings.ideogram.styleTypeis required and must be one of "AUTO", "REALISTIC", "FICTION". - When
providerSettings.ideogram.styleTypeis "FICTION",providerSettings.ideogram.characterReferenceImagesis required. - When
advancedFeatures.watermarkis sent: send exactly one ofadvancedFeatures.watermark.textoradvancedFeatures.watermark.image.
#Example
curl -X POST https://queue.auray.run/auray-serverless/ideogram/4-2 \
-H "Authorization: Bearer $AURAY_API_KEY" \
-H "content-type: application/json" \
-d '{
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const result = await auray.subscribe("auray-serverless/ideogram/4-2", {
input: {
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
},
onQueueUpdate: (update) => console.log(update.status),
});
console.dir(result, { depth: null });from auray_client import Client
auray = Client() # reads AURAY_API_KEY
result = auray.subscribe(
"auray-serverless/ideogram/4-2",
input={
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
},
on_queue_update=lambda update: print(update["status"]),
)
print(result){
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "run_model",
"arguments": {
"address": "auray-serverless/ideogram/4-2",
"input": {
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}
}
}
}const res = await fetch("https://queue.auray.run/auray-serverless/ideogram/4-2", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://queue.auray.run/auray-serverless/ideogram/4-2",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}`)
req, err := http.NewRequest("POST", "https://queue.auray.run/auray-serverless/ideogram/4-2", bytes.NewReader(body))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://queue.auray.run/auray-serverless/ideogram/4-2");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"inputs" => [
"referenceImages" => [
"https://v3b.auray.media/examples/samples/still-life.jpg",
],
],
"positivePrompt" => "a brass orrery on a walnut desk, morning light from a window to the left",
"width" => 1024,
"height" => 1024,
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
require "json"
uri = URI("https://queue.auray.run/auray-serverless/ideogram/4-2")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"inputs" => {
"referenceImages" => [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt" => "a brass orrery on a walnut desk, morning light from a window to the left",
"width" => 1024,
"height" => 1024
}.to_json
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String body = """
{
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-serverless/ideogram/4-2"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Post, "https://queue.auray.run/auray-serverless/ideogram/4-2");
var body = """
{
"inputs": {
"referenceImages": [
"https://v3b.auray.media/examples/samples/still-life.jpg"
]
},
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1024,
"height": 1024
}
""";
request.Content = new StringContent(body, Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");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.