Replace audio and voice tuning settings

Replace both the audio file and voice tuning settings for a cache entry in a single request. Sent as multipart/form-data with a file part containing the WAV audio (max 6 MB) and a settings part containing a JSON object with text and config fields.

PUT /v1/agents/{agentId}/audio-cache/{entryId}/details

Replace audio file and voice tuning settings

cURL

curl --request PUT \
  --url https://api.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <api-key>' \
  --form file='@example-file' \
  --form 'settings=<string>'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "settings": "<string>" }
headers = {"X-API-KEY": "<api-key>"}

response = requests.put(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('settings', '<string>');

const options = {method: 'PUT', headers: {'X-API-KEY': '<api-key>'}};

options.body = form;

fetch('https://api.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details', 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.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"settings\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "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.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"settings\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")

	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.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details")
  .header("X-API-KEY", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"settings\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/audio-cache/{entryId}/details")

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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"settings\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

400

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

agentId · string · required

entryId · string · required

Audio cache entry ID

Body

multipart/form-data

file · file · required

WAV audio file (max 6 MB)

settings · string · required

JSON string with shape {"text": string, "config": VoiceTuningConfig}, where VoiceTuningConfig matches the VoiceTuningConfig schema. text is the transcript to associate with the cache entry; config carries provider-specific voice tuning settings.

Response

204

Audio and settings updated