Docs

Running a model

RecraftText to image

Recraft V4 Pro Vector

Advanced vectorization with enhanced control for professional workflows

POSTauray-serverless/recraft/v4-pro-vector
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): 5.9604. From 4.1944 to 9.4372 megapixels a request. Priced up to height 3072, width 3072; 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
positivePromptstringyes—Text prompt describing elements to include in the generated output. Documented range: 1 to 10,000 characters.
widthintegerno2048Width of the generated media in pixels.
heightintegerno2048Height of the generated media in pixels.
settingsobjectno—
settings.backgroundColorobjectno—
settings.backgroundColor.rgbinteger[]no—Color as [red, green, blue] array.
settings.colorsobject[]no—
settings.colors[].rgbinteger[]no—Color as [red, green, blue] array.
outputTypestringno"URL"Image output type. One of "URL".
outputFormatstringno"SVG"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 "SVG".
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 width is sent or height is sent, width and height must be one of these: 2K (1:1): width 2048, height 2048; 2K (2:1): width 3072, height 1536; 2K (1:2): width 1536, height 3072; 2K (3:2): width 2560, height 1664; 2K (2:3): width 1664, height 2560; 2K (4:3): width 2432, height 1792; 2K (3:4): width 1792, height 2432; 2K (5:4): width 2304, height 1792; 2K (4:5): width 1792, height 2304; 2K (6:10): width 1664, height 2688; 2K (14:10): width 2560, height 1792; 2K (10:14): width 1792, height 2560; and 2 more (14 in all).
  • When settings.backgroundColor is sent: settings.backgroundColor.rgb is required. In every item of settings.colors: settings.colors[].rgb is required.

#Example

curl -X POST https://queue.auray.run/auray-serverless/recraft/v4-pro-vector \
  -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