Running a model
PixVerseText to videoPixVerse V5
PixVerse V5 cinematic text to video and image to video
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): 2 for resolution=360p; resolution=540p; 5 for resolution=720p; 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
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
inputs | object | no | — | |
inputs.frameImages | string[] | 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 2. |
positivePrompt | string | yes | — | Text prompt describing elements to include in the generated output. Documented range: 2 to 2,048 characters. |
negativePrompt | string | no | — | Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 2 to 2,048 characters. |
width | integer | no | 1920 | Width of the generated media in pixels. |
height | integer | no | 1080 | Height of the generated media in pixels. |
resolution | string | no | "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". |
duration | integer | no | — | 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. |
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. |
providerSettings | object | no | — | |
providerSettings.pixverse | object | no | — | |
providerSettings.pixverse.effect | string | no | — | Visual effect template. One of "bikini up", "the tigers touch", "jiggle jiggle", "hug your love", "kiss me ai", "subject 3 fever", "fin-tastic mermaid", "lets ymca", "skeleton dance", "kungfu club", "boom drop", "vroom vroom step", "creepy devil smile", "pubg winner hit", "360 microwave", "eye zoom challenge", "muscle surge", "punch face", "balloon belly", "kiss kiss". |
providerSettings.pixverse.style | string | no | — | Artistic style aesthetic for video generation. One of "anime", "3d_animation", "clay", "comic", "cyberpunk". |
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. |
safety | object | no | — | |
safety.checkContent | boolean | no | — | Enable or disable content safety checking. Increases total generation time. Always on: a false is sent as true. |
safety.mode | string | no | "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_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. |
#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
heightwheneverwidthis sent. Sendwidthwheneverheightis sent. - When
inputs.frameImagesis sent, do not send a request wherewidthis sent, or whereheightis sent. Otherwise,widthandheightare required. - Do not send
resolutiontogether withwidthorheight. - When
widthis sent orheightis sent,widthandheightmust 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
resolutionis sent,inputs.frameImagesis required.
#Example
curl -X POST https://queue.auray.run/auray-serverless/pixverse/1-5 \
-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
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const result = await auray.subscribe("auray-serverless/pixverse/1-5", {
input: {
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
},
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/1-5",
input={
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
},
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/1-5",
"input": {
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
}
}
}
}const res = await fetch("https://queue.auray.run/auray-serverless/pixverse/1-5", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://queue.auray.run/auray-serverless/pixverse/1-5",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
}`)
req, err := http.NewRequest("POST", "https://queue.auray.run/auray-serverless/pixverse/1-5", 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/1-5");
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([
"positivePrompt" => "a brass orrery on a walnut desk, morning light from a window to the left",
"width" => 1920,
"height" => 1080,
], 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/1-5")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"positivePrompt" => "a brass orrery on a walnut desk, morning light from a window to the left",
"width" => 1920,
"height" => 1080
}.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 = """
{
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-serverless/pixverse/1-5"))
.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/1-5");
var body = """
{
"positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left",
"width": 1920,
"height": 1080
}
""";
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.