latestSwagger 2.02026-08-19218237253.7 KB

3af866d68651

Audio

Produce a piece of music from a text description, such as "epic orchestral battle theme" or "calm piano melody", with optional lyrics. Synchronous: the call blocks until generation finishes and returns a single audio result containing a URL; there is no separate polling step. The description field is required; duration must be one of the allowed values (0 means auto, otherwise multiples of 10 up to 180 seconds) and out-of-range values return HTTP 400. Credits are charged on success. Use this for songs and musical scores; use createSoundEffect for short sound effects, createAmbiance for looping background soundscapes, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via getAudioResults. Requires an API key (user scope).

post/audio/music

Request body

descriptionstring required

Text description of the music to generate (e.g., "epic orchestral battle theme", "calm piano melody").

lyricsstring

Optional lyrics to include in the generated music.

duration0 | 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100 | 110 | 120 | 130 | 140 | 150 | 160 | 170 | 180

Duration in seconds. Use 0 for automatic duration based on the description.

augment_promptboolean

Augment the prompt behind the scenes. Disable to have more control.

request_idstring

Optional client-provided identifier for this request. Use this to retrieve results later via the results endpoint.

Response

Success

urlstring

URL to the generated audio file

typestring
durationnumber float
request_idstring
created_atinteger