Skip to main content
PUT
/
v1
/
create.new_song
create.new_song
curl --request PUT \
  --url https://api.soundpiece.co/v1/create.new_song \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lyrics": "<string>",
  "reference": {
    "url": "<string>"
  },
  "callback_url": "<string>"
}
'
{
  "song": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lyrics": "<string>",
    "prompt": "<string>",
    "reference": {
      "url": "<string>"
    },
    "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.

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

Response

Successful Response

​
song
Song · object
required