Skip to main content
PUT
/
v1
/
create.remix_song
create.remix_song
curl --request PUT \
  --url https://api.soundpiece.co/v1/create.remix_song \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": {
    "url": "<string>"
  },
  "lyrics": "<string>",
  "prompt": "<string>",
  "callback_url": "<string>",
  "n_variations": 1
}
'
{
  "remix_song": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": {
      "url": "<string>"
    },
    "lyrics": "<string>",
    "prompt": "<string>",
    "n_variations": 2,
    "outputs": [
      {
        "url": "<string>",
        "expires_at": "2023-11-07T05:31:56Z",
        "duration": 123
      }
    ],
    "error": {
      "message": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.soundpiece.co/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
source
AudioSource · object
required

The audio track to remix.

​
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:

[Verse]
This is a demo song, don't get too excited
Wrote it in me lounge while slightly half-sighted

[Chorus]
It's only a demo, keep your hopes low
Recorded it once, then decided "that'll go"
Required string length: 1 - 3000
​
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
​
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
​
n_variations
integer
default:1

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

Required range: 1 <= x <= 3

Response

Successful Response

​
remix_song
RemixSong · object
required