Running a model
ACE-Step v1.5 Base
Open-source music generation with voice cloning, lyric editing, and multilingual support
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-audio · Scope audio:write (or external:write on an older key) · 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. 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.audio | string | no | — | Audio input (an http(s) URL; upload a local file first and send its read URL). A URL. |
positivePrompt | string | yes | — | Text prompt describing elements to include in the generated output. Documented range: 2 to 3,000 characters. |
negativePrompt | string | no | — | Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: 2 to 3,000 characters. |
duration | number | no | 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 | 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. |
steps | integer | no | 100 | Total number of denoising steps. Higher values generally produce more detailed results but take longer. Documented range: 1 to 300. |
CFGScale | number | no | 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 | no | 0.5 | Fraction of steps using the input source instead of generated output. Documented range: 0 to 1. |
settings | object | no | — | |
settings.bpm | integer | no | — | Beats per minute. If not set, the model decides automatically. Documented range: 30 to 300. |
settings.guidanceType | string | no | "apg" | Controls how guidance is applied during generation. One of "apg", "cfg". |
settings.keyScale | string | no | — | Musical key and scale in '{Note}{Accidental} {Mode}' format (e.g. 'C major', 'F# minor', 'Bb major'). |
settings.lyrics | string | no | — | Song lyrics, typically formatted like a lyrics website. Documented range: 10 to 3,000 characters. |
settings.repaintingEnd | number | no | — | 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 | no | — | 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 | no | — | Beats per measure. If not set, the model decides automatically. One of 2, 3, 4, 6. |
settings.vocalLanguage | string | no | "en" | ISO 639-1 language code for vocals. unknown for instrumental or auto detection. 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". |
outputType | string | no | "URL" | Audio output type. One of "URL". |
outputFormat | string | no | "MP3" | 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 "MP3", "WAV", "FLAC", "OGG". |
audioSettings | object | no | — | |
audioSettings.bitrate | integer | no | — | Audio bitrate in kbps. Documented range: 8 or more. |
audioSettings.channels | integer | no | 2 | Number of audio channels. 1 for mono, 2 for stereo. One of 1, 2. |
audioSettings.sampleRate | integer | no | — | Audio sample rate in Hz. |
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.
- When
outputFormatis one of "WAV", "FLAC", do not sendaudioSettings. - When
outputFormatis "MP3",audioSettings.sampleRatemust be one of 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000. WhenoutputFormatis "MP3", whenaudioSettings.sampleRateis one of 16000, 22050, 24000,audioSettings.bitratemust be between 8 and 160. WhenoutputFormatis "MP3", whenaudioSettings.sampleRateis one of 32000, 44100, 48000,audioSettings.bitratemust be between 32 and 320. WhenoutputFormatis "MP3", whenaudioSettings.sampleRateis one of 8000, 11025, 12000,audioSettings.bitratemust be between 8 and 64. - When
outputFormatis "OGG",audioSettings.sampleRatemust be one of 8000, 12000, 16000, 24000, 48000. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 8000 andaudioSettings.channelsis 2,audioSettings.bitratemust be between 16 and 80. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 12000 andaudioSettings.channelsis 1,audioSettings.bitratemust be between 16 and 48. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 12000 andaudioSettings.channelsis 2,audioSettings.bitratemust be between 16 and 96. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 16000 andaudioSettings.channelsis 1,audioSettings.bitratemust be between 16 and 96. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 16000 andaudioSettings.channelsis 2,audioSettings.bitratemust be between 24 and 192. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 24000 andaudioSettings.channelsis 1,audioSettings.bitratemust be between 16 and 80. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 24000 andaudioSettings.channelsis 2,audioSettings.bitratemust be between 32 and 160. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 48000 andaudioSettings.channelsis 1,audioSettings.bitratemust be between 32 and 224. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 48000 andaudioSettings.channelsis 2,audioSettings.bitratemust be between 48 and 256. WhenoutputFormatis "OGG", whenaudioSettings.sampleRateis 8000 andaudioSettings.channelsis 1,audioSettings.bitratemust be between 8 and 40. - When
inputs.audiois sent, do not sendduration. - When
strengthis sent,inputs.audiois required. - When
settings.repaintingStartis sent orsettings.repaintingEndis sent,inputs.audiois required. - When
negativePromptis sent,CFGScalemust be above 1.
#Example
curl -X POST https://queue.auray.run/auray-serverless/ace-step-v1-5-base \
-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"
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const result = await auray.subscribe("auray-serverless/ace-step-v1-5-base", {
input: {
"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/ace-step-v1-5-base",
input={
"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/ace-step-v1-5-base",
"input": {
"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/ace-step-v1-5-base", {
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"
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://queue.auray.run/auray-serverless/ace-step-v1-5-base",
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"
},
)
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"
}`)
req, err := http.NewRequest("POST", "https://queue.auray.run/auray-serverless/ace-step-v1-5-base", 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/ace-step-v1-5-base");
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",
], 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/ace-step-v1-5-base")
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"
}.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"
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-serverless/ace-step-v1-5-base"))
.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/ace-step-v1-5-base");
var body = """
{
"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.