# auray-serverless/ace-step-v1-5-base

`POST https://queue.auray.run/auray-serverless/ace-step-v1-5-base` submits; the response carries a `request_id` and the three URLs to use next.

`POST https://auray.run/auray-serverless/ace-step-v1-5-base` 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*steps@100`): 0.0334. From 30 to 900 seconds of output a request. A request that sends `inputs.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/ace-step-v1-5-base
Servers: https://queue.auray.run · https://auray.run
Scope:   audio:write
Auth:    Authorization: Bearer auray_sk_…
API enabled: yes

## Input

- inputs.audio (url, optional) — Audio input (an http(s) URL; upload a local file first and send its read URL).
- positivePrompt (string, required) — Text prompt describing elements to include in the generated output. Documented range: 2 to 3,000 characters.
- negativePrompt (string, optional) — Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 2 to 3,000 characters.
- duration (number, optional, default: 60) — Length of the generated audio track in seconds. Accepted range: 30 to 120. The maximum was measured on 2026-10-02: the model fails above it, so a larger value is refused before anything is charged.
- 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.
- steps (integer, optional, default: 100) — Total number of denoising steps. Higher values generally produce more detailed results but take longer. Documented range: 1 to 300.
- CFGScale (number, optional, default: 10) — Guidance scale representing how closely the output will resemble the prompt. Higher values produce results more aligned with the prompt. Documented range: 1 to 30.
- strength (number, optional, default: 0.5) — Fraction of steps using the input source instead of generated output. Documented range: 0 to 1.
- settings.bpm (integer, optional) — Beats per minute. If not set, the model decides automatically. Documented range: 30 to 300.
- settings.guidanceType (string, optional, default: "apg", one of: "apg", "cfg") — Controls how guidance is applied during generation.
- settings.keyScale (string, optional) — Musical key and scale in '{Note}{Accidental} {Mode}' format (e.g. 'C major', 'F# minor', 'Bb major').
- settings.lyrics (string, optional) — Song lyrics, typically formatted like a lyrics website. Documented range: 10 to 3,000 characters.
- settings.repaintingEnd (number, optional) — End time in seconds for repaint region. Requires input audio. Values beyond audio duration append new audio. Documented range: 0 to 300.
- settings.repaintingStart (number, optional) — Start time in seconds for repaint region. Requires input audio. Negative values prepend audio before the start. Documented range: -300 to 300.
- settings.timeSignature (integer, optional, one of: 2, 3, 4, 6) — Beats per measure. If not set, the model decides automatically.
- settings.vocalLanguage (string, optional, default: "en", one of: "unknown", "ar", "az", "bg", "bn", "ca", "cs", "da", "de", "el", "en", "es", "fa", "fi", "fr", "he", "hi", "hr", "ht", "hu", "id", "is", "it", "ja", "ko", "la", "lt", "ms", "ne", "nl", "no", "pa", "pl", "pt", "ro", "ru", "sa", "sk", "sr", "sv", "sw", "ta", "te", "th", "tl", "tr", "uk", "ur", "vi", "yue", "zh") — ISO 639-1 language code for vocals. `unknown` for instrumental or auto detection.
- outputType (string, optional, default: "URL", one of: "URL") — Audio output type.
- outputFormat (string, optional, default: "MP3", one of: "MP3", "WAV", "FLAC", "OGG") — 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.
- audioSettings.bitrate (integer, optional) — Audio bitrate in kbps. Documented range: 8 or more.
- audioSettings.channels (integer, optional, default: 2, one of: 1, 2) — Number of audio channels. 1 for mono, 2 for stereo.
- audioSettings.sampleRate (integer, optional) — Audio sample rate in Hz.
- 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.

- When `outputFormat` is one of "WAV", "FLAC", do not send `audioSettings`.
- When `outputFormat` is "MP3", `audioSettings.sampleRate` must be one of 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000. When `outputFormat` is "MP3", when `audioSettings.sampleRate` is one of 16000, 22050, 24000, `audioSettings.bitrate` must be between 8 and 160. When `outputFormat` is "MP3", when `audioSettings.sampleRate` is one of 32000, 44100, 48000, `audioSettings.bitrate` must be between 32 and 320. When `outputFormat` is "MP3", when `audioSettings.sampleRate` is one of 8000, 11025, 12000, `audioSettings.bitrate` must be between 8 and 64.
- When `outputFormat` is "OGG", `audioSettings.sampleRate` must be one of 8000, 12000, 16000, 24000, 48000. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 8000 and `audioSettings.channels` is 2, `audioSettings.bitrate` must be between 16 and 80. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 12000 and `audioSettings.channels` is 1, `audioSettings.bitrate` must be between 16 and 48. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 12000 and `audioSettings.channels` is 2, `audioSettings.bitrate` must be between 16 and 96. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 16000 and `audioSettings.channels` is 1, `audioSettings.bitrate` must be between 16 and 96. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 16000 and `audioSettings.channels` is 2, `audioSettings.bitrate` must be between 24 and 192. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 24000 and `audioSettings.channels` is 1, `audioSettings.bitrate` must be between 16 and 80. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 24000 and `audioSettings.channels` is 2, `audioSettings.bitrate` must be between 32 and 160. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 48000 and `audioSettings.channels` is 1, `audioSettings.bitrate` must be between 32 and 224. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 48000 and `audioSettings.channels` is 2, `audioSettings.bitrate` must be between 48 and 256. When `outputFormat` is "OGG", when `audioSettings.sampleRate` is 8000 and `audioSettings.channels` is 1, `audioSettings.bitrate` must be between 8 and 40.
- When `inputs.audio` is sent, do not send `duration`.
- When `strength` is sent, `inputs.audio` is required.
- When `settings.repaintingStart` is sent or `settings.repaintingEnd` is sent, `inputs.audio` is required.
- When `negativePrompt` is sent, `CFGScale` must be above 1.

## 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*steps@100`): 0.0334. From 30 to 900 seconds of output a request. A request that sends `inputs.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/ace-step-v1-5-base
  Run auray-serverless/ace-step-v1-5-base
GET https://queue.auray.run/auray-serverless/ace-step-v1-5-base/requests/{request_id}
  The result
GET https://queue.auray.run/auray-serverless/ace-step-v1-5-base/requests/{request_id}/status
  The status
PUT https://queue.auray.run/auray-serverless/ace-step-v1-5-base/requests/{request_id}/cancel
  Ask for a cancellation

## Example

```bash
curl -X POST https://queue.auray.run/auray-serverless/ace-step-v1-5-base \
  -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"}'
```

## Full contract

https://api.auray.ai/v1/models/auray-serverless/ace-step-v1-5-base/openapi.json