Docs

Running a model

PixVerseVideo to video

PixVerse Modify

Mask-aware video editing for swaps, removals, restyling, and prompt-driven scene changes

POSTauray-serverless/pixverse/modify-0
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 video-to-video · Scope video:write (or external:write on an older key) · Price Credits per call: 24 for resolution=360p; 30 for resolution=540p; 35 for resolution=720p. Plus 149.5 credits when the request sends inputs.video (counted as any:inputs.video). 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.referenceImagesstring[]no—List of reference images (an http(s) URL; upload a local file first and send its read URL). Documented range: 1 to 3.
inputs.videostringyes—Video input (an http(s) URL; upload a local file first and send its read URL). A URL.
inputs.masksstring[]no—Mask identifiers for targeted regions. Auto-generated when keyframe and referenceImages are provided without masks. Documented range: up to 1.
positivePromptstringyes—Text prompt describing elements to include in the generated output. Documented range: 1 to 2,048 characters.
resolutionstringno"360p"Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "360p", "540p", "720p".
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.
settingsobjectno—
settings.keyframeintegerno—Frame index in the input video used as anchor for editing. Documented range: 0 or more.
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.

  • When resolution is sent, send at least one of inputs.referenceImages or inputs.video.

#Example

curl -X POST https://queue.auray.run/auray-serverless/pixverse/modify-0 \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "inputs": {
    "video": "https://v3b.auray.media/examples/samples/coffee-pour.mp4"
  },
  "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