Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
idempotency_key
string<uuid>
required

A unique UUID you choose. Send the same key to retry safely; we'll return the original response without doing the work again.

Example:

"3f2b8c1e-9d4a-4e7b-b6c5-1a2d3e4f5a6b"

lyrics
string
required

Song lyrics. Use [Verse], [Chorus], [Bridge], [Intro], [Outro], [Instrumental] section markers on their own line to structure the song. Each subsequent line within a section is a separate vocal line.

Example:

Required string length: 1 - 3000
reference
AudioSource · object
required

An audio source to use as a reference for generation.

callback_url
string<uri> | null

Optional HTTPS URL we'll POST the final response to when the operation reaches ready or failed. Polling remains the canonical source of truth; webhooks are a best-effort latency optimisation.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks/soundpiece"

n_variations
integer
default:1

How many output variations to produce (1-3).

Required range: 1 <= x <= 3
loudness
Target · object

A target loudness to normalise audio to. Every field has a default, so {} asks for the defaults: -14 LUFS, compression allowed.

Response

Successful Response

song
Song · object
required