curl --request PUT \
--url https://api.soundpiece.co/v1/create.new_sample \
--header 'Content-Type: application/json' \
--data '
{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"callback_url": "<string>",
"loopable": false
}
'import requests
url = "https://api.soundpiece.co/v1/create.new_sample"
payload = {
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"callback_url": "<string>",
"loopable": False
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt: '<string>',
duration: 123,
callback_url: '<string>',
loopable: false
})
};
fetch('https://api.soundpiece.co/v1/create.new_sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.soundpiece.co/v1/create.new_sample",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt' => '<string>',
'duration' => 123,
'callback_url' => '<string>',
'loopable' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.soundpiece.co/v1/create.new_sample"
payload := strings.NewReader("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.soundpiece.co/v1/create.new_sample")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.soundpiece.co/v1/create.new_sample")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}"
response = http.request(request)
puts response.read_body{
"sample": {
"id": "<string>",
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"loopable": true,
"output": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"duration": 123
},
"error": {
"code": "internal_error",
"message": "<string>"
}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}create.new_sample
Submit a sample generation request.
Returns immediately with status: processing. Use the matching GET to
poll for completion, or supply a callback_url to receive a webhook.
Samples are short audio clips generated from a text prompt at the
requested duration. Set loopable: true to produce a clip designed to
repeat seamlessly. A prompt rejected by our content policy returns the
operation as failed with tos_violation.
Credits cost: 3 per request. Insufficient credits returns 402 —
see errors.
curl --request PUT \
--url https://api.soundpiece.co/v1/create.new_sample \
--header 'Content-Type: application/json' \
--data '
{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"callback_url": "<string>",
"loopable": false
}
'import requests
url = "https://api.soundpiece.co/v1/create.new_sample"
payload = {
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"callback_url": "<string>",
"loopable": False
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt: '<string>',
duration: 123,
callback_url: '<string>',
loopable: false
})
};
fetch('https://api.soundpiece.co/v1/create.new_sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.soundpiece.co/v1/create.new_sample",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt' => '<string>',
'duration' => 123,
'callback_url' => '<string>',
'loopable' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.soundpiece.co/v1/create.new_sample"
payload := strings.NewReader("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.soundpiece.co/v1/create.new_sample")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.soundpiece.co/v1/create.new_sample")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"duration\": 123,\n \"callback_url\": \"<string>\",\n \"loopable\": false\n}"
response = http.request(request)
puts response.read_body{
"sample": {
"id": "<string>",
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"duration": 123,
"loopable": true,
"output": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"duration": 123
},
"error": {
"code": "internal_error",
"message": "<string>"
}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
A unique UUID you choose. Send the same key to retry safely; we'll return the original response without doing the work again.
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).
1 - 1024Duration in seconds.
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.
1 - 2048Whether the sample should be designed to loop seamlessly.
Response
Successful Response
Show child attributes
Show child attributes
