Docs

Running a model

MetaText to image

Meta Muse Image

Agentic image generation and editing with multi-reference composition, clean text rendering, and precise local edits

POSTauray-serverless/meta/muse-image
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 Credits per megapixel (counted as width*height): 0.3392 for settings.thinkingLevel=high; 0.4153 for settings.thinkingLevel=low. Each band has its own least and most a request is counted at. Priced up to height 2048, width 2352; 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

FieldTypeRequiredDefaultDescription
inputsobjectno—
inputs.referenceImagesstring[]no—List of reference images (an http(s) URL; upload a local file first and send its read URL). Documented range: 1 to 10.
positivePromptstringyes—Text prompt describing elements to include in the generated output. Documented range: 1 to 200,000 characters.
widthintegerno1920Width of the generated media in pixels.
heightintegerno1280Height of the generated media in pixels.
resolutionstringno—Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "2K".
settingsobjectno—
settings.imageSearchbooleannotruePull visual references for real places, products, logos, and styles.
settings.moderationstringno"auto"Content moderation level. Only auto is sent here: any other value is sent as auto. One of "auto", "low".
settings.shellbooleannotrueAllow the model to run code to build charts, tables, and structured layouts before rendering.
settings.thinkingLevelstringno"high"Controls the depth of internal reasoning the model performs before generating a response. One of "high", "low".
settings.webSearchbooleannotrueGround the generation in web results for current facts.
outputTypestringno"URL"Image output type. One of "URL".
outputFormatstringno"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".
outputQualityintegerno95Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99.
safetyobjectno—
safety.checkContentbooleanno—Enable or disable content safety checking. Increases total generation time. Always on: a false is sent as true.
advancedFeaturesobjectno—
advancedFeatures.watermarkobjectno—
advancedFeatures.watermark.textstringno—Watermark text. Documented range: 2 to 32 characters.
advancedFeatures.watermark.imagestringno—Watermark image (an http(s) URL; upload a local file first and send its read URL). A URL.
advancedFeatures.watermark.displayPositionstringno—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.opacitynumberno—Watermark opacity. Documented range: 0.1 to 1.
advancedFeatures.watermark.fontColorstringno—Text color in hex format.
advancedFeatures.watermark.bgColorstringno—Background color in hex format.
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 resolution together with width or height.
  • When resolution is sent, inputs.referenceImages is required.
  • When width is sent or height is sent, width and height must be one of these: 2K (1:1): width 1600, height 1600; 2K (3:2): width 1920, height 1280; 2K (2:3): width 1280, height 1920; 2K (4:3): width 1792, height 1344; 2K (3:4): width 1344, height 1792; 2K (16:9): width 2048, height 1152; 2K (9:16): width 1152, height 2048; 2K (21:9): width 2352, height 1008.
  • When advancedFeatures.watermark is sent: send exactly one of advancedFeatures.watermark.text or advancedFeatures.watermark.image.

#Example

curl -X POST https://queue.auray.run/auray-serverless/meta/muse-image \
  -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