Docs

Running a model

Black Forest LabsImage to image

Black Forest Labs FLUX Virtual Try-On

Low-latency virtual try-on for transferring garments onto a person image with strong identity and garment fidelity

POSTauray-serverless/bfl/flux-vto
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 image-to-image · Scope image:write (or external:write on an older key) · Price Credits per call (counted as steps@4): 6. From 1 to 1 calls a request. 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
inputsobjectyes—
inputs.referenceImagesobject[]yes—
inputs.referenceImages[].imagestringyes—Image input (an http(s) URL; upload a local file first and send its read URL). Images under 2MP pass through unchanged. Images over 2MP are downscaled to 1MP with the original aspect ratio preserved. A URL.
inputs.referenceImages[].rolestringyes—Role of the image in the virtual try-on process. Use exactly one person and one garment. One of "person", "garment".
positivePromptstringyes—Text prompt describing elements to include in the generated output. Documented range: 2 to 3,000 characters.
seedintegerno—Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range. Documented range: 0 to 9,223,372,036,854,776,000.
stepsintegerno4Total number of denoising steps. Higher values generally produce more detailed results but take longer. Documented range: 1 to 4.
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.

  • inputs.referenceImages must hold exactly 2 items. In every item of inputs.referenceImages: inputs.referenceImages[].image and inputs.referenceImages[].role are required.
  • When advancedFeatures.watermark is sent: send exactly one of advancedFeatures.watermark.text or advancedFeatures.watermark.image.
  • inputs.referenceImages is required and must hold exactly 2 items.

#Example

curl -X POST https://queue.auray.run/auray-serverless/bfl/flux-vto \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "inputs": {
    "referenceImages": [
      {
        "image": "https://v3b.auray.media/examples/samples/still-life.jpg",
        "role": "person"
      },
      {
        "image": "https://v3b.auray.media/examples/samples/still-life.jpg",
        "role": "garment"
      }
    ]
  },
  "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