Create Audio Book

This Creates an Audio Book and immediately starts AI Processing on the Audio book input Text.

POST /v1/audio_books/

Create Audio Book

cURL

curl --request POST \
  --url https://voice.plotweaver.app/v1/audio_books/ \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "<string>",
  "name": "<string>",
  "use_voice_clone": false,
  "preset_voice_name": "<string>",
  "voice_clone_sample": "<string>"
}
'

import requests

url = "https://voice.plotweaver.app/v1/audio_books/"

payload = {
    "file": "<string>",
    "name": "<string>",
    "use_voice_clone": False,
    "preset_voice_name": "<string>",
    "voice_clone_sample": "<string>"
}
headers = {
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    file: '<string>',
    name: '<string>',
    use_voice_clone: false,
    preset_voice_name: '<string>',
    voice_clone_sample: '<string>'
  })
};

fetch('https://voice.plotweaver.app/v1/audio_books/', 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://voice.plotweaver.app/v1/audio_books/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file' => '<string>',
    'name' => '<string>',
    'use_voice_clone' => false,
    'preset_voice_name' => '<string>',
    'voice_clone_sample' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "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://voice.plotweaver.app/v1/audio_books/"

	payload := strings.NewReader("{\n  \"file\": \"<string>\",\n  \"name\": \"<string>\",\n  \"use_voice_clone\": false,\n  \"preset_voice_name\": \"<string>\",\n  \"voice_clone_sample\": \"<string>\"\n}")

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

	req.Header.Add("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.post("https://voice.plotweaver.app/v1/audio_books/")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file\": \"<string>\",\n  \"name\": \"<string>\",\n  \"use_voice_clone\": false,\n  \"preset_voice_name\": \"<string>\",\n  \"voice_clone_sample\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://voice.plotweaver.app/v1/audio_books/")

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

request = Net::HTTP::Post.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file\": \"<string>\",\n  \"name\": \"<string>\",\n  \"use_voice_clone\": false,\n  \"preset_voice_name\": \"<string>\",\n  \"voice_clone_sample\": \"<string>\"\n}"

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

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file": "<string>",
  "name": "<string>",
  "audio_book_cover": "https://example.com/covers/cover01.jpg",
  "date_created": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "localized_file": "<string>",
  "task_status": "<string>",
  "task_progress": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

API-KEY · string · header · required

Body

application/json

file · string · required

A Public accessible URI or path string pointing to the text file.

Example:

"https://dpodkdhb03iee.cloudfront.net/TESTS/a553898a-e693-4c15-b3e6-32db42cf9482_AudioBook.txt"

name · string · required

The title of your audiobook

Example:

"The Great Gatsby: Afro-Centric Edition"

source_language · enum<string> · required

The starting language (case-sensitive to your Enum)

Available options: French, English, Amharic, Swahili, Chinese, Japanese, Korean, German, Russian, Portuguese, Spanish, Italian, Arabic, Dutch, Hindi, Urdu

Example:

"English"

target_language · enum<string> · required

A String of valid Language enum values

Available options: French, English, Amharic, Swahili, Chinese, Japanese, Korean, German, Russian, Portuguese, Spanish, Italian, Arabic, Dutch, Hindi, Urdu

Examples:

"English"

"Hindu"

"Chinese"

use_voice_clone · boolean · default: false

Flag indicating whether a voice clone should be used or not

preset_voice_name · string | null

Preset Voice to be used for the Audio Book Audio

voice_clone_sample · string | null

Public URL to a sample voice audio, only used when use_voice_clone is True

Response

201

application/json

Successful Response

id · string<uuid> · required

file · string · required

A Public accessible URI or path string pointing to the text file.

Example:

"https://dpodkdhb03iee.cloudfront.net/TESTS/a553898a-e693-4c15-b3e6-32db42cf9482_AudioBook.txt"

name · string · required

The title of your audiobook

Example:

"The Great Gatsby: Afro-Centric Edition"

source_language · enum<string> · required

The starting language (case-sensitive to your Enum)

Available options: French, English, Amharic, Swahili, Chinese, Japanese, Korean, German, Russian, Portuguese, Spanish, Italian, Arabic, Dutch, Hindi, Urdu

Example:

"English"

target_language · enum<string> · required

A String of valid Language enum values

Available options: French, English, Amharic, Swahili, Chinese, Japanese, Korean, German, Russian, Portuguese, Spanish, Italian, Arabic, Dutch, Hindi, Urdu

Examples:

"English"

"Hindu"

"Chinese"

audio_book_cover · string | null · required

Public Accessible URI to an image to be used as the Audio Book Cover

Example:

"https://example.com/covers/cover01.jpg"

date_created · string<date-time> · required

date_updated · string<date-time> · required

localized_file · string | null

task_status · string | null

task_progress · number | null