Update Story Item Volume
curl --request PUT \
--url https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"volume": 1
}'import requests
url = "https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume"
payload = { "volume": 1 }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({volume: 1})
};
fetch('https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume', 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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume",
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([
'volume' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume"
payload := strings.NewReader("{\n \"volume\": 1\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"volume\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"volume\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"story_id": "<string>",
"generation_id": "<string>",
"start_time_ms": 123,
"created_at": "2023-11-07T05:31:56Z",
"profile_id": "<string>",
"profile_name": "<string>",
"text": "<string>",
"language": "<string>",
"audio_path": "<string>",
"duration": 123,
"seed": 123,
"instruct": "<string>",
"generation_created_at": "2023-11-07T05:31:56Z",
"version_id": "<string>",
"track": 0,
"trim_start_ms": 0,
"trim_end_ms": 0,
"engine": "<string>",
"volume": 1,
"versions": [
{
"id": "<string>",
"generation_id": "<string>",
"label": "<string>",
"audio_path": "<string>",
"is_default": true,
"created_at": "2023-11-07T05:31:56Z",
"effects_chain": [
{
"type": "<string>",
"enabled": true,
"params": {}
}
],
"source_version_id": "<string>"
}
],
"active_version_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Stories
Update Story Item Volume
Set a story item’s per-clip volume (linear gain, 0.0–2.0).
PUT
/
stories
/
{story_id}
/
items
/
{item_id}
/
volume
Update Story Item Volume
curl --request PUT \
--url https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"volume": 1
}'import requests
url = "https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume"
payload = { "volume": 1 }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({volume: 1})
};
fetch('https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume', 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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume",
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([
'volume' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume"
payload := strings.NewReader("{\n \"volume\": 1\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"volume\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/voice/stories/{story_id}/items/{item_id}/volume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"volume\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"story_id": "<string>",
"generation_id": "<string>",
"start_time_ms": 123,
"created_at": "2023-11-07T05:31:56Z",
"profile_id": "<string>",
"profile_name": "<string>",
"text": "<string>",
"language": "<string>",
"audio_path": "<string>",
"duration": 123,
"seed": 123,
"instruct": "<string>",
"generation_created_at": "2023-11-07T05:31:56Z",
"version_id": "<string>",
"track": 0,
"trim_start_ms": 0,
"trim_end_ms": 0,
"engine": "<string>",
"volume": 1,
"versions": [
{
"id": "<string>",
"generation_id": "<string>",
"label": "<string>",
"audio_path": "<string>",
"is_default": true,
"created_at": "2023-11-07T05:31:56Z",
"effects_chain": [
{
"type": "<string>",
"enabled": true,
"params": {}
}
],
"source_version_id": "<string>"
}
],
"active_version_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Set a story item’s per-clip volume (linear gain, 0.0–2.0).
PUT /api/voice/stories/{story_id}/items/{item_id}/volume
All requests authenticate with your PeachDesk API key in the X-API-Key header (an interactive session token in Authorization: Bearer also works — see Authentication). Use the playground to send a live request and inspect the response.Authorizations
ApiKeyAuthSessionAuth
Organization API key (bibha_...). Takes precedence over the session credential, and is refused outright on user-session-only and super-admin routes.
Body
application/json
Request model for adjusting a story item's playback volume.
Linear gain. 1.0 is the original level, 0.0 is silent. Capped
above 1.0 so a too-aggressive boost can't blow out the mix or clip
the export.
Required range:
0 <= x <= 2Response
Successful Response
Detail model for story item with generation info.
Show child attributes
Show child attributes

