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

​
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

Response

Successful Response

​
fx
Fx · object
required