Running a model
IdeogramImage to imageIdeogram Object Remover
Mask-based object removal with natural scene reconstruction and no prompt required
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 call: 3. 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.image | string | yes | — | Image input (an http(s) URL; upload a local file first and send its read URL). The long side is capped at 1024 px. Larger images are downscaled with the aspect ratio preserved and the result is returned at the reduced size. A URL. |
inputs.mask | string | yes | — | Image used to specify which areas of the input image should be edited (an http(s) URL; upload a local file first and send its read URL). White marks the area to edit, black is preserved. A URL. |
seed | integer | no | — | Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range. Documented range: 0 to 2,147,483,647. |
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.
- When
advancedFeatures.watermarkis sent: send exactly one ofadvancedFeatures.watermark.textoradvancedFeatures.watermark.image.
#Example
curl -X POST https://queue.auray.run/auray-serverless/ideogram/object-remover-0 \
-H "Authorization: Bearer $AURAY_API_KEY" \
-H "content-type: application/json" \
-d '{
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const result = await auray.subscribe("auray-serverless/ideogram/object-remover-0", {
input: {
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
},
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/object-remover-0",
input={
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
},
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/object-remover-0",
"input": {
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}
}
}
}const res = await fetch("https://queue.auray.run/auray-serverless/ideogram/object-remover-0", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://queue.auray.run/auray-serverless/ideogram/object-remover-0",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}`)
req, err := http.NewRequest("POST", "https://queue.auray.run/auray-serverless/ideogram/object-remover-0", 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/object-remover-0");
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" => [
"image" => "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask" => "https://v3b.auray.media/examples/samples/still-life-mask.png",
],
], 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/object-remover-0")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"inputs" => {
"image" => "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask" => "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}.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": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-serverless/ideogram/object-remover-0"))
.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/object-remover-0");
var body = """
{
"inputs": {
"image": "https://v3b.auray.media/examples/samples/still-life.jpg",
"mask": "https://v3b.auray.media/examples/samples/still-life-mask.png"
}
}
""";
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.