Docs

Running a model

PixVerseText to video

PixVerse V5 Fast

Fast text to video and image to video generation for rapid iteration

POSTauray-serverless/pixverse/1-5-fast
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-video · Scope video:write (or external:write on an older key) · Price Credits per second of output (counted as duration): 4.2 for resolution=360p; resolution=540p; resolution=720p; 5.1563 for resolution=1080p. Every request is counted at 8 seconds of output, whatever duration it names. 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.frameImagesstring[]no—Images that pin frames of the video, as a list of image URLs: one image is the first frame, two are the first and the last, and three or more anchor the first and the last with the rest spread evenly between. Each item is a plain URL; the object form that names a frame or a timestamp is not accepted here. Documented range: 1 to 1.
positivePromptstringyes—Text prompt describing elements to include in the generated output. Documented range: 2 to 2,048 characters.
negativePromptstringno—Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 2 to 2,048 characters.
widthintegerno1920Width of the generated media in pixels.
heightintegerno1080Height of the generated media in pixels.
resolutionstringno"720p"Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "360p", "540p", "720p", "1080p".
durationintegerno—Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps). One of 5, 8.
seedintegerno—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.
outputTypestringno"URL"Video output type. One of "URL".
outputFormatstringno"MP4"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 "MP4", "WEBM", "MOV".
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.
safety.modestringno"fast"Safety checking mode for video generation. Only fast or full is sent here: any other value is sent as fast. One of "fast", "full".
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.frameImages is sent, do not send a request where width is sent, or where height is sent. Otherwise, width and height are required.
  • Do not send resolution together with width or height.
  • When width is sent or height is sent, width and height must be one of these: 360p (16:9): width 640, height 360; 360p (4:3): width 480, height 360; 360p (1:1): width 360, height 360; 360p (3:4): width 360, height 480; 360p (9:16): width 360, height 640; 540p (16:9): width 960, height 540; 540p (4:3): width 720, height 540; 540p (1:1): width 540, height 540; 540p (3:4): width 540, height 720; 540p (9:16): width 540, height 960; 720p (16:9): width 1280, height 720; 720p (4:3): width 960, height 720; and 8 more (20 in all).
  • When resolution is sent, inputs.frameImages is required.

#Example

curl -X POST https://queue.auray.run/auray-serverless/pixverse/1-5-fast \
  -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",
  "width": 1920,
  "height": 1080
}'

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