# auray-serverless/pixverse/1-1

`POST https://queue.auray.run/auray-serverless/pixverse/1-1` submits; the response carries a `request_id` and the three URLs to use next.

`POST https://auray.run/auray-serverless/pixverse/1-1` is the same request run synchronously: the connection is held and the response is the model's OUTPUT, the same document the result URL would have answered. A request that usually takes longer than a run may hold its connection is refused `400 model_not_synchronous` there before anything is charged, naming `expected_seconds` and `wait_ceiling_seconds` — submit it to the queue instead. Past the deadline a run is `504 run_timed_out` with `X-Auray-Request-Timeout-Type: user` — the request is still alive, running and charged or, while it waits to start, not yet charged (`charged` says which) — so poll `status_url` rather than resending, or resend with the same `idempotency_key` to be handed this request again instead of a second one. A run holds one of the connections this platform, this product and your account may keep waiting; with all of them in use it is refused `429 wait_capacity` with `Retry-After` before anything is charged (`charged: false`), and retrying after that pause is safe.

One of Auray's catalogue models, billed once in credits. Whether it runs right now is `GET /v1/catalogue`'s `addresses` (no key needed): `connected` runs; `described` answers `501 model_not_connected` and `paused` `503 model_disabled`, both before anything is charged.

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.

Fields as published for this model.

Every error code is explained at https://auray.ai/docs/api/errors.

Address: auray-serverless/pixverse/1-1
Servers: https://queue.auray.run · https://auray.run
Scope:   video:write
Auth:    Authorization: Bearer auray_sk_…
API enabled: yes

## Input

- inputs.frameImages (array of url, optional) — 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, required) — Text prompt describing elements to include in the generated output. Documented range: 2 to 2,048 characters.
- negativePrompt (string, optional) — Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 2 to 2,048 characters.
- width (integer, optional, default: 1920) — Width of the generated media in pixels.
- height (integer, optional, default: 1080) — Height of the generated media in pixels.
- resolution (string, optional, default: "720p", one of: "360p", "540p", "720p", "1080p") — Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.
- duration (integer, optional, one of: 5, 8) — 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).
- seed (integer, optional) — 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.pixverse.effect (string, optional, 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") — Visual effect template.
- providerSettings.pixverse.motionMode (string, optional, default: "normal", one of: "normal", "fast") — Motion intensity in the generated video.
- providerSettings.pixverse.style (string, optional, one of: "anime", "3d_animation", "clay", "comic", "cyberpunk") — Artistic style aesthetic for video generation.
- outputType (string, optional, default: "URL", one of: "URL") — Video output type.
- outputFormat (string, optional, default: "MP4", one of: "MP4", "WEBM", "MOV") — 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.
- outputQuality (integer, optional, default: 95) — Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99.
- safety.checkContent (boolean, optional) — Enable or disable content safety checking. Increases total generation time. Always on: a false is sent as true.
- safety.mode (string, optional, default: "fast", one of: "fast", "full") — Safety checking mode for video generation. Only `fast` or `full` is sent here: any other value is sent as `fast`.
- idempotency_key (string, optional) — 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.

## Rules

Across fields, as the model's documentation states them; judged before any charge, and warned (Deprecation) until enforcement starts.

- 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 `providerSettings.pixverse.motionMode` is "fast", `duration` must be one of 5. When `providerSettings.pixverse.motionMode` is "fast", `width` and `height` must be one of these: width 640, height 360; width 480, height 360; width 360, height 360; width 360, height 480; width 360, height 640; width 960, height 540; width 720, height 540; width 540, height 540; width 540, height 720; width 540, height 960; width 1280, height 720; width 960, height 720; and 3 more (15 in all).
- When `resolution` is sent, `inputs.frameImages` is required.
- When `resolution` is "1080p", `width` is 1920 and `height` is 1080, `width` is 1440 and `height` is 1080, `width` is 1080 and `height` is 1080, `width` is 1080 and `height` is 1440 or `width` is 1080 and `height` is 1920, `duration` must be one of 5.

## Response

A submit answers the status document (`status`: IN_QUEUE, IN_PROGRESS or COMPLETED; `request_id`;
`queue_position` while queued; `logs`; `metrics`) and then, beside it:
- product (string) — Which of this platform's products ran it.
- provider_job_id (string) — The id the job runs under, once it has been handed to its model — possibly while still `queued`; null before. Quote it to support.
- model (string) — The address that ran it, echoed back.
- engine (string) — The service's own name for the model that ran, where it reports one — a catalogue model's is its `id` on GET /v1/models; null otherwise. What `model` carried before it carried the address.
- attribution (string) — The credit line the model's licence requires you to show; null where none is required.
- credits_charged (integer) — What this job cost. 0 on a replay, or when a pass or a promotion paid for it (`coverage` says which).
- credits_quoted (integer) — What this job costs, in credits: the price it was quoted at submit. Equal to `credits_charged` once it has been charged; while it waits in the queue to start, `credits_charged` is 0 and this is what it will be charged when it starts (a cancel before then costs nothing) — and a replay of a job still waiting quotes the body that job was queued with, which is the one it runs, not the replay's. For a catalogue model it is the hold, and the settle may give part of it back — a settled read's `credits_charged` says what it finally cost.
- coverage (object) — Present when a pass or a promotion paid for this job — `{"by": "pass", "pass": "seedance-2-5"}` or `{"by": "promotion"}`, and `credits_charged` is 0 — or when you hold a pass for this model that did not cover this job: `{"by": null, "miss": {"pass": "video", "why": "door"}}`, `why` being `door` (the pass does not work here) or `shape` (it does not cover this kind of job). Absent otherwise. Send `X-Auray-Covered-Only: 1` to run a job only if a pass or a promotion pays for it.
- credits_remaining (integer) — The balance after it.
- expected_seconds (integer) — A rough render time, for a progress bar; 0 where nothing is published.
- give_up_after_seconds (integer) — The longest this job may take from its submit: the longest it may wait to start (your X-Auray-Request-Timeout, or the product's queue deadline) plus the longest it may run before it is stopped and refunded. Waiting longer is waiting for nothing; the official clients wait this long by default. For a catalogue model the part it may run is its own reap as its registry row states it (`lifecycle.stall_ceiling_seconds` on GET /v1/models); otherwise these are the published limits: we may lengthen them during an incident, never shorten them.
- replayed (boolean) — `true` when your `idempotency_key` matched a job this platform already had. Nothing was charged and nothing was rendered twice.
- waited (boolean) — Present when `wait` was asked for. The rest of this group comes with it.
- timed_out (boolean) — The wait ran out before the job settled. Still a 2xx, never a 408 or 504 — a library that retries on those would resubmit and you would pay twice. Poll `status_url`.
- wait_declined (string) — No seat was free to hold the connection with, so the request was answered at once. `platform_busy`: no product would have helped. `product_busy`: another product's queue might. `account_busy`: you are already waiting on every seat your plan's lanes allow. The job is running either way; poll it.
- status_url (string) — Poll this.
- response_url (string) — Fetch the result from this once the status is COMPLETED.
- cancel_url (string) — `PUT` to this to ask for a cancellation.
Poll `status_url`, fetch `response_url` once COMPLETED, `PUT` `cancel_url` to stop it.

## Price

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.

## Paths

POST https://queue.auray.run/auray-serverless/pixverse/1-1
  Run auray-serverless/pixverse/1-1
GET https://queue.auray.run/auray-serverless/pixverse/1-1/requests/{request_id}
  The result
GET https://queue.auray.run/auray-serverless/pixverse/1-1/requests/{request_id}/status
  The status
PUT https://queue.auray.run/auray-serverless/pixverse/1-1/requests/{request_id}/cancel
  Ask for a cancellation

## Example

```bash
curl -X POST https://queue.auray.run/auray-serverless/pixverse/1-1 \
  -H 'Authorization: Bearer auray_sk_…' \
  -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}'
```

## Full contract

https://api.auray.ai/v1/models/auray-serverless/pixverse/1-1/openapi.json