Running a model
PixVerseImage to videoPixVerse Modify
Mask-aware video editing for swaps, removals, restyling, and prompt-driven scene changes
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-video · Scope video:write (or external:write on an older key) · Price Credits per call: 33.96 for resolution=360p; 42.45 for resolution=540p; 49.525 for resolution=720p. Plus 145.745 credits when the request sends inputs.video at resolution=360p (counted as any:inputs.video). Plus 218.6175 credits when the request sends inputs.video at resolution=540p (counted as any:inputs.video). Plus 218.6175 credits when the request sends inputs.video at resolution=720p (counted as any:inputs.video). An MP4 or MOV clip in inputs.video that you uploaded through POST /v1/uploads, that one of your jobs made on a catalogue model or an auray-ai/ model, or that is a file of a Cinema Studio project you can open, is held for its own length instead, where its length can be read from the file: 4.874415 credits for each second it runs at resolution=360p, 7.311622 at resolution=540p, 7.311622 at resolution=720p, rounded up to the next whole second, up to 29.9 seconds. Any other clip — a WebM, a file whose length cannot be read, or a clip sent by any other link — is held for the full 29.9 seconds; credits_quoted says which hold was taken. 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.
#What it can do
edit-video— Edit video: 1 source file; up to 3 pictures (optional); 1 mask (optional)- Resolutions: 360p, 540p, 720p
- Prompt: up to 2,048 characters
- Sound: makes no sound of its own
- Priced by:
call(the whole rule is under Price)
Find the addresses that do any of these with GET /v1/models?operation=<id>; the openapi.json carries them as data under x-auray-capability.
#Input
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
inputs | object | yes | — | |
inputs.referenceImages | string[] | no | — | List of reference images (an http(s) URL). Documented range: 1 to 3. When the request also sends inputs.video, this model makes the person in a picture here speak or move: a picture you upload, or a link from anywhere else, is taken once your account has accepted, one time, that you have the right to the faces and voices you use — send acceptance: {"real_people": "2026-11-03"} with the request, or accept in the Auray app — and is refused 403 acceptance_required until then, before anything is charged. A picture made here — a job's result — asks nothing. While uploads are paused here, a picture you upload, or a link from anywhere else, is refused 403 likeness_not_made_here instead, before anything is charged. The files the examples here send are ours, and are taken. |
inputs.video | string | yes | — | Video input (an http(s) URL; upload a local file first and send its read URL). A URL. |
inputs.masks | string[] | no | — | Mask identifiers for targeted regions. Auto-generated when keyframe and referenceImages are provided without masks. Documented range: up to 1. |
positivePrompt | string | yes | — | Text prompt describing elements to include in the generated output. Documented range: 1 to 2,048 characters. |
resolution | string | no | "360p" | Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "360p", "540p", "720p". |
seed | integer | no | — | 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. |
settings | object | no | — | |
settings.keyframe | integer | no | — | Frame index in the input video used as anchor for editing. Documented range: 0 or more. |
outputType | string | no | "URL" | Video output type. One of "URL". |
outputFormat | string | no | "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". |
outputQuality | integer | no | 95 | Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99. |
idempotency_key | string | no | — | 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. |
acceptance | object | no | — | Your account's one acceptance, sent with the request that first needs it: a file of a real person's face or voice you upload, in a field this model makes speak or move, copies the voice of or puts into a clip, is taken once your account has accepted, one time, that you have the right to the faces and voices you use. Kept for your account before anything is charged, so no later request asks again — in any app or through the API — and asked of no file made here. You can accept in the Auray app (Account → Privacy) instead; an assistant cannot accept for you, so through MCP it is accepted in the app. |
acceptance.real_people | string | no | — | The version of the words you accept: that you have the right to every face and voice you upload, and to any voice or style you pick that sounds like a real person — it is yours, or you have permission — and that you are responsible for what you make with them. One of "2026-11-03". |
#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
resolutionis sent, send at least one ofinputs.referenceImagesorinputs.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"
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const result = await auray.subscribe("auray-serverless/pixverse/modify-0", {
input: {
"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"
},
onQueueUpdate: (update) => console.log(update.status),
});
console.dir(result, { depth: null });from auray_client import Client
auray = Client() # reads AURAY_API_KEY
result = auray.subscribe(
"auray-serverless/pixverse/modify-0",
input={
"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"
},
on_queue_update=lambda update: print(update["status"]),
)
print(result){
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "run_model",
"arguments": {
"address": "auray-serverless/pixverse/modify-0",
"input": {
"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"
}
}
}
}const res = await fetch("https://queue.auray.run/auray-serverless/pixverse/modify-0", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"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"
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://queue.auray.run/auray-serverless/pixverse/modify-0",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"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"
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"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"
}`)
req, err := http.NewRequest("POST", "https://queue.auray.run/auray-serverless/pixverse/modify-0", bytes.NewReader(body))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://queue.auray.run/auray-serverless/pixverse/modify-0");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"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",
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
require "json"
uri = URI("https://queue.auray.run/auray-serverless/pixverse/modify-0")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"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"
}.to_json
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String body = """
{
"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"
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-serverless/pixverse/modify-0"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Post, "https://queue.auray.run/auray-serverless/pixverse/modify-0");
var body = """
{
"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"
}
""";
request.Content = new StringContent(body, Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");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.
