Skip to main content
POST
/
voice-changer
/
sse
Voice Changer (SSE)
curl --request POST \
  --url https://api.cartesia.ai/voice-changer/sse \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form clip='@example-file' \
  --form 'voice[id]=<string>' \
  --form 'output_format[sample_rate]=123' \
  --form 'output_format[bit_rate]=123'
import requests

url = "https://api.cartesia.ai/voice-changer/sse"

files = { "clip": ("example-file", open("example-file", "rb")) }
payload = {
"voice[id]": "<string>",
"output_format[sample_rate]": "123",
"output_format[bit_rate]": "123"
}
headers = {
"Cartesia-Version": "<cartesia-version>",
"X-API-Key": "<api-key>"
}

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

print(response.text)
const form = new FormData();
form.append('clip', '<string>');
form.append('voice[id]', '<string>');
form.append('output_format[sample_rate]', '123');
form.append('output_format[bit_rate]', '123');

const options = {
method: 'POST',
headers: {'Cartesia-Version': '<cartesia-version>', 'X-API-Key': '<api-key>'}
};

options.body = form;

fetch('https://api.cartesia.ai/voice-changer/sse', 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.cartesia.ai/voice-changer/sse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clip\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voice%5Bid%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bsample_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bbit_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Cartesia-Version: <cartesia-version>",
"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.cartesia.ai/voice-changer/sse"

payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clip\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voice%5Bid%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bsample_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bbit_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001--")

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

req.Header.Add("Cartesia-Version", "<cartesia-version>")
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.post("https://api.cartesia.ai/voice-changer/sse")
.header("Cartesia-Version", "<cartesia-version>")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clip\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voice%5Bid%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bsample_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bbit_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001--")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cartesia.ai/voice-changer/sse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Cartesia-Version"] = '<cartesia-version>'
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clip\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voice%5Bid%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bsample_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format%5Bbit_rate%5D\"\r\n\r\n123\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "done": false,
  "status_code": 206,
  "step_time": 123,
  "data": "aSDinaTvuI8gbWludGxpZnk=",
  "sample_rate": 44100
}

Authorizations

X-API-Key
string
header
required

Headers

Cartesia-Version
enum<string>
required

API version header.

Available options:
2024-11-13
Example:

"2024-11-13"

Body

multipart/form-data
clip
file

Supported audio formats: flac, mp3, mpeg, mpga, oga, ogg, wav, webm

voice[id]
string
output_format[container]
enum<string>
Available options:
raw,
wav,
mp3
output_format[sample_rate]
integer
output_format[encoding]
enum<string> | null

Required for raw and wav containers.

Available options:
pcm_f32le,
pcm_s16le,
pcm_mulaw,
pcm_alaw
output_format[bit_rate]
integer | null

Required for mp3 containers.

Response

200 - text/event-stream

Server-sent events stream. Each frame is data: <json>\n\n where the JSON payload matches VoiceChangerSSEEvent.

Audio data chunk.

status_code
enum<integer>
required

HTTP-style status code. Always 206 for chunk events.

Available options:
206
done
enum<boolean>
required

Whether this is the final event for the request. Always false for chunk events.

Available options:
false
data
string
required

Base64-encoded audio data.

sample_rate
integer
required

The sample rate of the audio in Hz.

step_time
number
required

Server-side processing time for this chunk in milliseconds.