Docs

Running a model

ByteDanceText to image

ByteDance Seedream 5.0 Pro

Flagship image model for controlled editing, multi-reference generation, and layer-aware visual workflows

POSTauray-serverless/bytedance/seedream-5-0-pro
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): 3.179 for settings.thinking=false; settings.thinking=true. From 1.5729 to 268.4027 megapixels a request. Plus 0.2675 credits per input image (counted as items:inputs.referenceImages, the first 1 free), up to 10 input images. Plus 3.024917 credits when resolution=2K (counted as any:resolution). 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.
positivePromptstringno—Text prompt describing elements to include in the generated output. Documented range: 2 to 3,000 characters.
widthintegerno1536Width of the generated media in pixels. Documented range: 256 to 16,383.
heightintegerno1024Height of the generated media in pixels. Documented range: 256 to 16,383.
resolutionstringno—Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "1K", "2K".
settingsobjectno—
settings.backgroundstringno"opaque"Background handling in generated images. One of "opaque", "transparent".
settings.layerDecompositionbooleanno—Enables layer decomposition of the reference image. The layers are returned in outputs.layers next to the base image. outputFormat applies to the base image only, layers are always PNG.
settings.thinkingbooleannotrueEnables thinking mode for improved quality at the cost of increased generation time.
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.
  • When inputs.referenceImages is not sent, send at least one of width and height or resolution.
  • Do not send resolution together with width or height.
  • Do not send a request where settings.background is "transparent" and settings.layerDecomposition is true.
  • When settings.layerDecomposition is true, do not send a request where width is sent, or where height is sent, or where positivePrompt is sent.
  • Unless settings.layerDecomposition is true, positivePrompt is required.
  • When settings.layerDecomposition is true, inputs.referenceImages is required and must hold at most 1 item.
  • When settings.background is "transparent", outputFormat must be one of "PNG", "WEBP". When settings.background is "transparent", inputs.referenceImages is required and must hold at most 1 item.
  • 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/bytedance/seedream-5-0-pro \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "width": 1536,
  "height": 1024,
  "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