Skip to main content
POST
/
voices
/
preview
Voice Preview
curl --request POST \
  --url https://api.faseeh.ai/api/v1/voices/preview \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'text=<string>' \
  --form similarity=0.5 \
  --form 'model_id=<string>' \
  --form file='@example-file' \
  --form speed=1
import requests

url = "https://api.faseeh.ai/api/v1/voices/preview"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "text": "<string>",
    "similarity": "0.5",
    "model_id": "<string>",
    "speed": "1"
}
headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const form = new FormData();
form.append('text', '<string>');
form.append('similarity', '0.5');
form.append('model_id', '<string>');
form.append('file', '<string>');
form.append('speed', '1');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.faseeh.ai/api/v1/voices/preview', 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.faseeh.ai/api/v1/voices/preview",
  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=\"text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model_id\"\r\n\r\n<string>\r\n-----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=\"speed\"\r\n\r\n1\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.faseeh.ai/api/v1/voices/preview"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model_id\"\r\n\r\n<string>\r\n-----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=\"speed\"\r\n\r\n1\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", 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.post("https://api.faseeh.ai/api/v1/voices/preview")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model_id\"\r\n\r\n<string>\r\n-----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=\"speed\"\r\n\r\n1\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.faseeh.ai/api/v1/voices/preview")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model_id\"\r\n\r\n<string>\r\n-----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=\"speed\"\r\n\r\n1\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
"<string>"
{
  "errorCode": "<string>",
  "errorMessage": "<string>"
}
{
  "errorCode": "<string>",
  "errorMessage": "<string>"
}
{
  "errorCode": "<string>",
  "errorMessage": "<string>"
}
{
  "errorCode": "<string>",
  "errorMessage": "<string>"
}

​
Authentication

Requires API key authentication via x-api-key header.

​
Request

Content-Type: multipart/form-data

​
Form Data

FieldTypeRequiredDescription
textstringYesText to generate preview with (minimum 3 words, 10 characters)
similaritynumberYesVoice similarity to source (0.0 to 1.0). Higher values produce more similar voice
model_idstringYesThe model identifier to use for generation
speednumberNoSpeech speed (0.7 to 1.2, default 1.0). Values below 1.0 slow down speech, above 1.0 speed it up
fileFileYesAudio file containing the voice to preview

​
Notes

  • The API will process the provided audio file to generate the voice preview
  • text must be at least 3 words and 10 characters long

​
Response

Status Code: 200 OK Headers:
  • Content-Type: audio/raw;codec=pcm16;rate=24000;channels=1
  • Cache-Control: no-cache
  • Connection: keep-alive
Body: Streaming PCM16 audio (24000 Hz, Mono, 16-bit)

​
Error Responses

400 Bad Request 
{
  "errorCode": "400xx",
  "errorMessage": "text is required"
}

{
  "errorCode": "400xx",
  "errorMessage": "similarity must be a number between 0 and 1"
}

{
  "errorCode": "400xx",
  "errorMessage": "speed must be a number between 0.7 and 1.2"
}

{
  "errorCode": "400xx",
  "errorMessage": "model_id is required"
}

{
  "errorCode": "400xx",
  "errorMessage": "file is required and must be of audio type"
}
401 Unauthorized 
{
  "errorCode": "40101",
  "errorMessage": "Invalid or missing API key"
}
402 Payment Required 
{
  "errorCode": "40201",
  "errorMessage": "Insufficient wallet balance"
}
500 Internal Server Error 
{
  "errorCode": "50001",
  "errorMessage": "Failed to generate voice preview"
}

​
Example Usage

​
JavaScript

const formData = new FormData();
const audioFile = document.querySelector('input[type="file"]').files[0];
formData.append("file", audioFile);
formData.append("text", "مرحبا بك في فصيح، هذا صوتي الجديد");
formData.append("similarity", "0.8");
formData.append("model_id", "faseeh-v1-preview");
formData.append("speed", "1.0");

const response = await fetch('https://api.faseeh.ai/api/v1/voices/preview', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    // Note: Content-Type is set automatically by FormData
  },
  body: formData,
});

if (response.ok) {
  // Handle streaming audio response
  const reader = response.body.getReader();
  const audioChunks = [];
  
  while (true) {
    const { done, value } = await reader.read();
    if (done) break;
    audioChunks.push(value);
  }
  
  // Combine chunks and create audio blob
  const audioBlob = new Blob(audioChunks, { type: 'audio/raw' });
  const audioUrl = URL.createObjectURL(audioBlob);
  // Use audioUrl to play the preview
} else {
  const error = await response.json();
  console.error('Error:', error);
}

​
Python

import requests

url = "https://api.faseeh.ai/api/v1/voices/preview"
headers = {
    "x-api-key": "YOUR_API_KEY"
}

with open("source_audio.wav", "rb") as audio_file:
    files = {"file": audio_file}
    data = {
        "text": "مرحبا بك في فصيح، هذا صوتي الجديد",
        "similarity": "0.8",
        "model_id": "faseeh-v1-preview",
        "speed": "1.0"
    }
    response = requests.post(url, files=files, data=data, headers=headers, stream=True)

if response.status_code == 200:
    # Save streaming audio
    with open("voice_preview.pcm", "wb") as f:
        for chunk in response.iter_content(chunk_size=8192):
            f.write(chunk)
    print("Voice preview saved successfully")
else:
    print(f"Error: {response.status_code} - {response.text}")

​
cURL

curl -X POST "https://api.faseeh.ai/api/v1/voices/preview" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@source_audio.wav" \
  -F "text=مرحبا بك في فصيح، هذا صوتي الجديد" \
  -F "similarity=0.8" \
  -F "model_id=faseeh-v1-preview" \
  -F "speed=1.0" \
  --output voice_preview.pcm
Voice Preview: This endpoint generates a preview of a cloned voice. If you’re satisfied with the preview, you can proceed to create it as a permanent voice using the voice creation endpoint.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

multipart/form-data
​
text
string
required

Text to generate preview with (minimum 3 words, 10 characters)

​
similarity
number
required

Voice similarity to source (0.0 to 1.0). Higher values produce more similar voice

Required range: 0 <= x <= 1
​
model_id
string
required

The model identifier to use for generation

​
file
file
required

Audio file containing the voice to preview

​
speed
number
default:1

Speech speed (0.7 to 1.2, default 1.0)

Required range: 0.7 <= x <= 1.2

Response

Streaming PCM16 audio preview

PCM16 audio stream (24000 Hz, Mono, 16-bit)