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"

prompt
string
required

Free-text description of the audio to generate. Mix tags, a description of the desired mood and instrumentation, and a scene — use commas to separate tags. Examples: rock song, energetic, male vocal (song), synthwave, melancholic, mid-tempo (instrumental), rock, guitar, energetic, no drums (sample), someone typing on a keyboard (effect).

Required string length: 1 - 1024
duration
number
required

Duration in seconds.

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"

loopable
boolean
default:false

Whether the sample should be designed to loop seamlessly.

Response

Successful Response

sample
Sample · object
required