# auray-serverless/sync/3-0

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

`POST https://auray.run/auray-serverless/sync/3-0` 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 call: 93. A request that sends `inputs.video` or `inputs.audio` or `settings.segments.[].audio` is refused before any charge: it has no price on this model. 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/sync/3-0
Servers: https://queue.auray.run · https://auray.run
Scope:   video:write
Auth:    Authorization: Bearer auray_sk_…
API enabled: yes

## Input

- inputs.video (url, required) — Video input (an http(s) URL; upload a local file first and send its read URL).
- inputs.audio (url, optional) — Audio input (an http(s) URL; upload a local file first and send its read URL).
- settings.temperature (number, optional, default: 0.5) — Expressiveness of lip sync and facial movements. Documented range: 0 to 1.
- settings.activeSpeakerDetection.autoDetect (boolean, optional) — Automatically detect and target the active speaker.
- settings.activeSpeakerDetection.boundingBoxes (array of array of number, optional) — Per-frame face bounding boxes across the clip. Each box is [x1, y1, x2, y2].
- settings.activeSpeakerDetection.coordinates (array of number, optional) — [x, y] point on the target speaker's face in the selected frame.
- settings.activeSpeakerDetection.frameNumber (integer, optional) — Frame index corresponding to the provided face coordinates. Documented range: 0 or more.
- settings.emotion (string, optional, one of: "happy", "sad", "angry", "disgusted", "surprised", "neutral") — Emotional tone for performance re-animation.
- settings.mode (string, optional, one of: "lips", "face", "head") — Controls the region of facial animation applied during lip sync.
- settings.occlusionDetection (boolean, optional) — Enable occlusion handling for obstructed faces.
- settings.segments[].audio (url, optional) — Audio input (an http(s) URL; upload a local file first and send its read URL).
- settings.segments[].audioEndTime (number, optional) — End time in seconds within the source audio file.
- settings.segments[].audioStartTime (number, optional, default: 0) — Start time in seconds within the source audio file. Documented range: 0 or more.
- settings.segments[].endTime (number, optional) — End time in seconds for the segment. Must be greater than startTime and within the source video's duration.
- settings.segments[].startTime (number, optional) — Start time in seconds for the segment. Documented range: 0 or more.
- settings.syncMode (string, optional, default: "cut_off", one of: "bounce", "cut_off", "silence", "remap") — Synchronization strategy when audio and video durations don't match.
- 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.

- Do not send `settings.activeSpeakerDetection.boundingBoxes` together with `settings.activeSpeakerDetection.coordinates`.
- Send exactly one of `inputs.audio` or `settings.segments`.
- Send `settings.activeSpeakerDetection.frameNumber` whenever `settings.activeSpeakerDetection.coordinates` is sent. Send `settings.activeSpeakerDetection.coordinates` whenever `settings.activeSpeakerDetection.frameNumber` is sent. `settings.segments` must hold at least 1 item. In every item of `settings.segments`: `settings.segments[].startTime`, `settings.segments[].endTime` and `settings.segments[].audio` are required.

## 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 call: 93. A request that sends `inputs.video` or `inputs.audio` or `settings.segments.[].audio` is refused before any charge: it has no price on this model. 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/sync/3-0
  Run auray-serverless/sync/3-0
GET https://queue.auray.run/auray-serverless/sync/3-0/requests/{request_id}
  The result
GET https://queue.auray.run/auray-serverless/sync/3-0/requests/{request_id}/status
  The status
PUT https://queue.auray.run/auray-serverless/sync/3-0/requests/{request_id}/cancel
  Ask for a cancellation

## Example

```bash
curl -X POST https://queue.auray.run/auray-serverless/sync/3-0 \
  -H 'Authorization: Bearer auray_sk_…' \
  -H 'Content-Type: application/json' \
  -d '{"inputs":{"video":"https://v3b.auray.media/examples/samples/coffee-pour.mp4","audio":"https://v3b.auray.media/examples/samples/electronic-loop.mp3"}}'
```

## Full contract

https://api.auray.ai/v1/models/auray-serverless/sync/3-0/openapi.json