VoiceLab - Akool open api documents

You can use the following APIs to create voice clones, text-to-speech, voice changer, and manage voice resources.

The resources (image, video, voice) generated by our API are valid for 7 days. Please save the relevant resources as soon as possible to prevent expiration.

Rates

Plan	Pro	Max	Business	Enterprise
Text-to-Speech	4.4 credits/1000 characters	3.2 credits/1000 characters	2.4 credits/1000 characters	Customized
Instant voice clone	30 voices	180 voices	500 voices	Customized
Voice changer	4.4 credits/minute	3.2 credits/minute	2.4 credits/minute	Customized

Models

Voice Model Overview: The following multilingual voice models are available for text-to-speech synthesis, each with strong performance across different language families.

Model Name	Description	Support Languages
Akool Multilingual 1	Performs well on English, Spanish, French, German, Italian, European Portuguese, Dutch, Russian, and other Western languages	`ar`,`bg`,`cs`,`da`,`de`,`el`,`en`,`es`, `fi`,`fil`,`fr`,`hi`,`hr`,`hu`,`id`,`it`, `ja`,`ko`,`ms`,`nb`,`nl`,`pl`,`pt`,`ro`, `ru`,`sk`,`sv`,`ta`,`tr`,`uk`,`vi`
Akool Multilingual 2	Excels at text-to-speech across various languages, but does not support voice cloning.	`af`,`am`,`ar`,`as`,`az`,`bg`,`bn`,`bs`, `ca`,`cs`,`cy`,`da`,`de`,`el`,`en`,`es`, `et`,`eu`,`fa`,`fi`,`fil`,`fr`,`ga`,`gl`, `gu`,`he`,`hi`,`hr`,`hu`,`hy`,`id`,`is`, `it`,`iu`,`ja`,`jv`,`ka`,`kk`,`km`,`kn`, `ko`,`lo`,`lt`,`lv`,`mk`,`ml`,`mn`,`mr`, `ms`,`mt`,`my`,`nb`,`ne`,`nl`,`or`,`pa`, `pl`,`ps`,`pt`,`ro`,`ru`,`si`,`sk`,`sl`, `so`,`sq`,`sr`,`su`,`sv`,`sw`,`ta`,`te`, `th`,`tr`,`uk`,`ur`,`uz`,`vi`,`zh`,`zu`
Akool Multilingual 3	Performs well on Chinese (Mandarin), Chinese (Cantonese ), Japanese, Korean, as well as English, Spanish, French, and other major Western languages	`zh`,`en`,`es`,`fr`,`ru`,`de`,`pt`,`ar`, `it`,`ja`,`ko`,`id`,`vi`,`tr`,`nl`,`uk`, `th`,`pl`,`ro`,`el`,`cs`,`fi`,`hi`,`bg`, `da`,`he`,`ml`,`fa`,`sk`,`sv`,`hr`,`fil`, `hu`,`nb`,`sl`,`ca`,`nn`,`ta`,`af`,`yue`
Akool Multilingual 4	Performs well on Portuguese (Brazil).	`en`,`fr`,`de`,`es`,`pt`,`zh`,`ja`,`hi`, `it`,`ko`,`nl`,`pl`,`ru`,`sv`,`tr`

Create Voice Clone

POST https://openapi.akool.com/api/open/v4/voice/clone

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Body Attributes

Parameter	Type	Required	Value	Description
source_voice_file	String	true		Original audio file URL, supports mp3, mp4, wav, etc. Must be a public accessible URL, The maximum file size is 30MB.
voice_options	Object	false		Audio tagging options
- style	Array	false		Voice style tags (e.g., [“Authoritative”, “Calm”])
- gender	Array	false		Gender tags (e.g., [“Male”, “Female”])
- age	Array	false		Age tags (e.g., [“Young”, “Middle”, “Elderly”])
- scenario	Array	false		Use case tags (e.g., [“Advertisement”, “Education”])
- remove_background_noise	Boolean	false	false	Remove background noise, disabled by default
- language	String	false	en	Language code (ISO 639-1) of the audio file. Defaults to “en” if not specified
- clone_prompt	String	false		Supported voice models: Akool Multilingual 3, Must match the audio content exactly, including punctuation, to enhance clone quality. Sound reproduction example audio. Providing this parameter will help enhance the similarity and stability of the voice synthesis’s sound quality. If using this parameter, a small sample audio segment must also be uploaded. The audio file uploaded must comply with the following specifications: The format of the uploaded audio file should be: mp3 or wav format; The duration of the uploaded audio file should be less than 8 seconds; The size of the uploaded audio file should not exceed 20 MB;
- need_volume_normalization	Boolean	false	false	Supported voice models: Akool Multilingual 3, Audio cloning parameter: Enable volume normalization, defaults to false
name	String	false		Audio name
webhookUrl	String	false		Callback url address based on HTTP request
voice_model_name	String	false		The designated model for Clone, Supported voice models: Akool Multilingual 1, Akool Multilingual 3, Akool Multilingual 4. getVoiceModelName

Response Attributes

Parameter	Type	Value	Description
code	int	1000	Interface returns business status code(1000:success)
msg	String		Interface returns status information
data	Object		Response data object
- uid	Integer	101400	User ID
- team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
- voice_id	String	null	Voice ID, this value will be updated after task completion, you can view it in the voiceList.Get Voice List
- gender	String	”Male”	Voice gender
- name	String	”MyVoice0626-01”	Voice name
- preview	String	null	Preview audio URL, this value will be updated after task completion, you can view it in the voiceList.Get Voice List
- text	String	”This is a comic style model…”	Preview text content
- duration	Number	8064	Audio duration in milliseconds
- status	Integer	1	Voice clone status: 【1:queueing, 2:processing, 3:completed, 4:failed】
- create_time	Long	1751349718268	Creation timestamp
- style	Array	[“Authoritative”, “Calm”]	Voice style tags
- scenario	Array	[“Advertisenment”]	Use case scenario tags
- age	Array	[“Elderly”, “Middle”]	Age category tags
- deduction_credit	Integer	0	Deducted credits
- webhookUrl	String	”Callback URL”	Callback URL
- _id	String	”686379d641e5eb74bb8dfe3f”	Document ID
- source_voice_file	String	”https://drz0f01yeq1cx.cloudfront.net/1751363983518-9431-audio1751363981879.webm”	Original audio file URL

Example

Body

{
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3",
    "name": "My Voice",
    "voice_options": {
        "remove_background_noise": true,
        "style": ["Authoritative","Calm","Confident","Enthusiastic"],
        "gender": ["Male"],
        "age": ["Elderly"],
        "scenario": ["Advertisenment"],
        "language": "en",
        "clone_prompt": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "need_volume_normalization": true
    },
    "voice_model_name": "Akool Multilingual 3",
    "webhookUrl": ""
}

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/clone' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3",
    "name": "My Voice",
    "voice_options": {
        "remove_background_noise": true,
        "style": ["Authoritative","Calm","Confident","Enthusiastic"],
        "gender": ["Male"],
        "age": ["Elderly"],
        "scenario": ["Advertisenment"],
        "language": "en",
        "clone_prompt": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "need_volume_normalization": true
    },
    "voice_model_name": "Akool Multilingual 3",
    "webhookUrl": ""
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"source_voice_file\": \"https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3\",\n    \"name\": \"Specify  Voice Model\",\n    \"voice_options\": {\n        \"remove_background_noise\": true,\n        \"style\": [\"Authoritative\",\"Calm\",\"Confident\",\"Enthusiastic\"],\n        \"gender\": [\"Male\"],\n        \"age\": [\"Elderly\"],\n        \"scenario\": [\"Advertisenment\"],\n        \"language\": \"en\",\n        \"clone_prompt\": \"In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.\",\n        \"need_volume_normalization\": true\n    },\n    \"voice_model_name\": \"Akool Multilingual 3\"\n,\n    \"webhookUrl\": \"\"\n}");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/clone")
  .method("POST", body)
  .addHeader("x-api-key", "{{API Key}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3",
    "name": "Specify Voice Model",
    "voice_options": {
        "remove_background_noise": true,
        "style": ["Authoritative","Calm","Confident","Enthusiastic"],
        "gender": ["Male"],
        "age": ["Elderly"],
        "scenario": ["Advertisenment"],
        "language": "en",
        "clone_prompt": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "need_volume_normalization": true
    },
    "voice_model_name": "Akool Multilingual 3",
    "webhookUrl": "",
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/clone", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}',
  'Content-Type' => 'application/json'
];
$body = '{
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3",
    "name": "Specify Voice Model",
    "voice_options": {
        "remove_background_noise": true,
        "style": ["Authoritative","Calm","Confident","Enthusiastic"],
        "gender": ["Male"],
        "age": ["Elderly"],
        "scenario": ["Advertisenment"],
        "language": "en",
        "clone_prompt": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "need_volume_normalization": true,
        "webhookUrl": "",
    },
    "voice_model_name": "Akool Multilingual 3"
}';
$request = new Request('POST', 'https://openapi.akool.com/api/open/v4/voice/clone', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests
import json

url = "https://openapi.akool.com/api/open/v4/voice/clone"

payload = json.dumps({
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1755534706613-000a30e917d848d9bd166b636530ae21-38a696952ca94b9eb9ecf07ced494a58.mp3",
    "name": "Specify Voice",
    "voice_options": {
        "remove_background_noise": true,
        "style": ["Authoritative","Calm","Confident","Enthusiastic"],
        "gender": ["Male"],
        "age": ["Elderly"],
        "scenario": ["Advertisenment"],
        "language": "en",
        "clone_prompt": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "need_volume_normalization": true
    },
    "voice_model_name": "Akool Multilingual 3",
    "webhookUrl": "",
})
headers = {
  'x-api-key':'{{API Key}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "uid": 101400,
        "team_id": "6805fb69e92d9edc7ca0b409",
        "voice_id": null,
        "gender": "Male",
        "name": "MyVoice0626-01",
        "preview": null,
        "text": "This is a comic style model, this is a comic style model, this is a comic style model, this is a comic style model",
        "duration": 8064,
        "status": 1,
        "create_time": 1751349718268,
        "style": [
            "Authoritative",
            "Calm"
        ],
        "scenario": [
            "Advertisenment"
        ],
        "age": [
            "Elderly",
            "Middle"
        ],
        "deduction_credit": 0,
        "webhookUrl": "",
        "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1751363983518-9431-audio1751363981879.webm",
        "_id": "686379d641e5eb74bb8dfe3f"
    }
}

Create Text to Speech

POST https://openapi.akool.com/api/open/v4/voice/tts

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Body Attributes

Parameter	Type	Required	Value	Description
input_text	String	true		For input text, the per-request character limit depends on the subscription plan: Pro – 5,000, Pro Max – 10,000, Business – 50,000.
voice_id	String	true		Voice ID, Voice synthesis ID. If both timber_weights and voice_id fields have values, timber_weights will not take effect.get this voice_id from your cloned voices or akool voice list.getVoiceId
voice_options	Object	false		Audio settings
- stability	Number	false		Voice stability (0-1) , Supported voice models: Akool Multilingual 1, Get Voice Model Name
- similarity_boost	Number	false		Similarity boost (0-1) , Supported voice models: Akool Multilingual 1, Get Voice Model Name
- style	Number	false		Voice style (0-1) , Supported voice models: Akool Multilingual 1, Akool Multilingual 2. Style examples: cheerful, Get Voice Model Name
- speed	Number	false		Speech speed (0.7-1.2) , Supported voice models: Akool Multilingual 1, Akool Multilingual 2, Akool Multilingual 3, Get Voice Model Name
- speaker_boost	Boolean	false		Speaker boost, Supported voice models: Akool Multilingual 1, Get Voice Model Name
- emotion	String	false		Emotion (happy, sad, angry, fearful, disgusted, surprised, neutral) , It only supports Chinese voice. Supported voice models: Akool Multilingual 2, Akool Multilingual 3, Get Voice Model Name
- volume	Integer	false		Volume (0-100) , Supported voice models: Akool Multilingual 2, Akool Multilingual 3, Get Voice Model Name
webhookUrl	String	false		Callback url address based on HTTP request
language_code	String	false		Currently supported: Akool Multilingual 1, Akool Multilingual 3 and Akool Multilingual 4. When passing in, only Language code (ISO 639-1) such as “zh”, “pt” is supported. This parameter is designed to enhance the use of minority languages. Adding audio effects will make it better, but it cannot achieve the effect of translation.
extra_options	Object	false		Additional parameter settings
- previous_text	String	false		Supported voice models: Akool Multilingual 1, getVoiceModelName. The text that came before the text of the current request. Can be used to improve the speech’s continuity when concatenating together multiple generations or to influence the speech’s continuity in the current generation.
- next_text	String	false		Supported voice models: Akool Multilingual 1, getVoiceModelName. The text that comes after the text of the current request. Can be used to improve the speech’s continuity when concatenating together multiple generations or to influence the speech’s continuity in the current generation.
- apply_text_normalization	String	false		Supported voice models: Akool Multilingual 1, getVoiceModelName. This parameter controls text normalization with three modes: ‘auto’, ‘on’, and ‘off’. When set to ‘auto’, the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With ‘on’, text normalization will always be applied, while with ‘off’, it will be skipped.
- apply_language_text_normalization	Boolean	false	false	Supported voice models: Akool Multilingual 1, getVoiceModelName. This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese.
- latex_read	Boolean	false	false	Supported voice models: Akool Multilingual 3, getVoiceModelName. Controls whether to read LaTeX formulas, defaults to false. Note: 1. Formulas in the request must be enclosed with $$ 2. Backslashes () in formulas must be escaped as \
- text_normalization	Boolean	false	false	Supported voice models: Akool Multilingual 3, getVoiceModelName. This parameter supports Chinese and English text normalization, improving performance in number reading scenarios but slightly increasing latency. Defaults to false if not provided.
- audio_setting	Object	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Audio generation parameter settings
— sample_rate	Integer	false	32000	Supported voice models: Akool Multilingual 3, getVoiceModelName. Audio sampling rate. Available range [8000, 16000, 22050, 24000, 32000, 44100], defaults to 32000
— bitrate	Integer	false	128000	Supported voice models: Akool Multilingual 3, getVoiceModelName. Audio bitrate. Available range [32000, 64000, 128000, 256000], defaults to 128000. This parameter only affects mp3 format audio
— format	String	false	mp3	Supported voice models: Akool Multilingual 3, getVoiceModelName. Audio format. Available options [mp3, wav], defaults to mp3. WAV format is only supported in non-streaming output
— channel	Integer	false	1	Supported voice models: Akool Multilingual 3, getVoiceModelName. Number of audio channels. Available options: [1,2], where 1 is mono and 2 is stereo, defaults to 1
- timber_weights	Array	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. List of mixed timbres, supporting up to 4 voice timbres. The higher the weight of a single timbre, the more similar the synthesized voice will be to that timbre. If both timber_weights and voice_id fields have values, timber_weights will not take effect.
— voice_id	String	Required within timber_weights parameter		Supported voice models: Akool Multilingual 3, getVoiceModelName. Voice timbre ID, must be filled in together with the weight parameter. Get this voice_id from your cloned voices or akool voice list.getVoiceId
— weight	Integer	Required within timber_weights parameter		Supported voice models: Akool Multilingual 3, getVoiceModelName. Weight of each voice timbre, must be filled in together with voice_id. Available range [1, 100], the higher the weight, the more similar the synthesized voice will be to that timbre
- pronunciation_dict	Object	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Pronunciation rules
— tone	Array	false	[“燕少飞/(yan4)(shao3)(fei1)”, “omg/oh my god”]	Supported voice models: Akool Multilingual 3, getVoiceModelName. Define special pronunciation rules for characters or symbols. For Chinese text, tones are represented by numbers: 1 for first tone, 2 for second tone, 3 for third tone, 4 for fourth tone, 5 for neutral tone
- voice_modify	Object	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Voice parameter adjustments
— pitch	Integer	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Pitch adjustment (deep/bright), range [-100,100]. Values closer to -100 make the voice deeper; closer to 100 make it brighter
— intensity	Integer	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Intensity adjustment (powerful/soft), range [-100,100]. Values closer to -100 make the voice more powerful; closer to 100 make it softer
— timbre	Integer	false		Timbre adjustment (resonant/crisp), range [-100,100]. Values closer to -100 make the voice more resonant; closer to 100 make it crisper
— sound_effects	String	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Sound effects settings, only one can be selected at a time. Available options: spacious_echo (spacious echo), auditorium_echo (auditorium broadcast), lofi_telephone (telephone distortion), robotic (electronic voice)
- subtitle_enable	Boolean	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Controls whether to enable subtitle service, defaults to false. This parameter is only effective in non-streaming output scenarios
- pitch	Integer	false		Supported voice models: Akool Multilingual 3, getVoiceModelName. Voice pitch, range [-12, 12], where 0 outputs the original timbre. Value must be an integer.

Response Attributes

Parameter	Type	Value	Description
code	int	1000	Interface returns business status code(1000:success)
msg	String		Interface returns status information
data	Object		Response data object
- create_time	Long	1751350015709	Creation timestamp
- uid	Integer	101400	User ID
- team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
- input_text	String	”Welcome to the Akool…”	Input text content
- preview	String	null	Generated audio URL, this value will be updated after task completion, you can view it in the resourceList.Get Resource List
- status	Integer	1	TTS status: 【1:queueing, 2:processing, 3:completed, 4:failed】
- webhookUrl	String	""	Callback URL
- duration	Integer	0	Audio duration in milliseconds
- file_name	String	”1ef1d76ebfc244f7a30430f7049d6ebc.mp3”	Generated file name
- gender	String	”Male”	Voice gender
- deduction_credit	Float	1.9295	Deducted credits
- name	String	”27fec311afd743aa889a057e17e93c13”	Generated name
- _id	String	”68637aff41e5eb74bb8dfe73”	Document ID
- voice_model_id	String	”686379d641e5eb74bb8dfe3f”	Voice document ID
- voice_id	String	”Tq06jbVyFH4l6R-Gjvo_V-p_nVYk5DRrYJZsxeDmlhEtyhcFKKLQODmgngI9llKw”	Voice ID
- voice_options	Object		Voice options object
- stability	Number	0.7	Voice stability setting
- similarity_boost	Number	0.5	Similarity boost setting
- style	Number	0.6	Voice style setting
- speed	Number	0.8	Speech speed setting
- speaker_boost	Boolean	false	Speaker boost setting
- emotion	String	”happy”	Emotion setting
- volume	Integer	50	Volume setting

Example

Body

{
    "input_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
    "voice_id": "6889b628662160e2caad5dbc",
    "voice_options": {
        "stability": 0.6,
        "similarity_boost": 0.8,
        "style": 1,
        "speed": 1.0,
        "speaker_boost": true,
        "emotion": "happy",
        "volume": 80
    },
    "pitch": -5,
    "webhookUrl": "",
    "language_code": "zh",
    "extra_options": {
        "previous_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "next_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "apply_text_normalization": "auto",
        "apply_language_text_normalization": true,
        "latex_read": true,
        "text_normalization": true,
        "audio_setting": {
            "sample_rate": 24000,
            "bitrate": 32000,
            "format": "mp3",
            "channel": 2
        },
        "timber_weights": [
            {
                "voice_id": "6889b7f4662160e2caad60e9",
                "weight": 80
            },
            {
                "voice_id": "6889b7f3662160e2caad60e8",
                "weight": 60
            },
            {
                "voice_id": "6889b7f3662160e2caad60e7",
                "weight": 30
            },
            {
                "voice_id": "6889b7f2662160e2caad60e6",
                "weight": 10
            }
        ],
        "pronunciation_dict": {
            "tone" : [
                    "雍容/(yong3)(neng4)",
                    "牡丹/(mu4)(dan3)"
                ]
        },
        "voice_modify": {
            "pitch": 50,
            "intensity": 30,
            "timbre": -50,
            "sound_effects": "robotic"
        },
        "subtitle_enable": true
    }
}

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/tts' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
    "input_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
    "voice_id": "6889b628662160e2caad5dbc",
    "voice_options": {
        "stability": 0.6,
        "similarity_boost": 0.8,
        "style": 1,
        "speed": 1.0,
        "speaker_boost": true,
        "emotion": "happy",
        "volume": 80
    },
    "pitch": -5,
    "webhookUrl": "",
    "language_code": "zh",
    "extra_options": {
        "previous_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "next_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "apply_text_normalization": "auto",
        "apply_language_text_normalization": true,
        "latex_read": true,
        "text_normalization": true,
        "audio_setting": {
            "sample_rate": 24000,
            "bitrate": 32000,
            "format": "mp3",
            "channel": 2
        },
        "timber_weights": [
            {
                "voice_id": "6889b7f4662160e2caad60e9",
                "weight": 80
            },
            {
                "voice_id": "6889b7f3662160e2caad60e8",
                "weight": 60
            },
            {
                "voice_id": "6889b7f3662160e2caad60e7",
                "weight": 30
            },
            {
                "voice_id": "6889b7f2662160e2caad60e6",
                "weight": 10
            }
        ],
        "pronunciation_dict": {
            "tone" : [
                    "雍容/(yong3)(neng4)",
                    "牡丹/(mu4)(dan3)"
                ]
        },
        "voice_modify": {
            "pitch": 50,
            "intensity": 30,
            "timbre": -50,
            "sound_effects": "robotic"
        },
        "subtitle_enable": true
    }
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"input_text\": \"In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.\",\n    \"voice_id\": \"6889b628662160e2caad5dbc\",\n    \"voice_options\": {\n        \"stability\": 0.6,\n        \"similarity_boost\": 0.8,\n        \"style\": 1,\n        \"speed\": 1.0,\n        \"speaker_boost\": true,\n        \"emotion\": \"happy\",\n        \"volume\": 80\n    },\n    \"pitch\": -5,\n    \"webhookUrl\": \"\",\n    \"language_code\": \"zh\",\n    \"extra_options\": {\n        \"previous_text\": \"In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.\",\n        \"next_text\": \"In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.\",\n        \"apply_text_normalization\": \"auto\",\n        \"apply_language_text_normalization\": true,\n        \"latex_read\": true,\n        \"text_normalization\": true,\n        \"audio_setting\": {\n            \"sample_rate\": 24000,\n            \"bitrate\": 32000,\n            \"format\": \"mp3\",\n            \"channel\": 2\n        },\n        \"timber_weights\": [\n            {\n                \"voice_id\": \"6889b7f4662160e2caad60e9\",\n                \"weight\": 80\n            },\n            {\n                \"voice_id\": \"6889b7f3662160e2caad60e8\",\n                \"weight\": 60\n            },\n            {\n                \"voice_id\": \"6889b7f3662160e2caad60e7\",\n                \"weight\": 30\n            },\n            {\n                \"voice_id\": \"6889b7f2662160e2caad60e6\",\n                \"weight\": 10\n            }\n        ],\n        \"pronunciation_dict\": {\n            \"tone\" : [\n                    \"雍容/(yong3)(neng4)\",\n                    \"牡丹/(mu4)(dan3)\"\n                ]\n        },\n        \"voice_modify\": {\n            \"pitch\": 50,\n            \"intensity\": 30,\n            \"timbre\": -50,\n            \"sound_effects\": \"robotic\"\n        },\n        \"subtitle_enable\": true\n    }\n}");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/tts")
  .method("POST", body)
  .addHeader("x-api-key", "{{API Key}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
    "input_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
    "voice_id": "6889b628662160e2caad5dbc",
    "voice_options": {
        "stability": 0.6,
        "similarity_boost": 0.8,
        "style": 1,
        "speed": 1.0,
        "speaker_boost": true,
        "emotion": "happy",
        "volume": 80
    },
    "pitch": -5,
    "webhookUrl": "",
    "language_code": "zh",
    "extra_options": {
        "previous_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "next_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "apply_text_normalization": "auto",
        "apply_language_text_normalization": true,
        "latex_read": true,
        "text_normalization": true,
        "audio_setting": {
            "sample_rate": 24000,
            "bitrate": 32000,
            "format": "mp3",
            "channel": 2
        },
        "timber_weights": [
            {
                "voice_id": "6889b7f4662160e2caad60e9",
                "weight": 80
            },
            {
                "voice_id": "6889b7f3662160e2caad60e8",
                "weight": 60
            },
            {
                "voice_id": "6889b7f3662160e2caad60e7",
                "weight": 30
            },
            {
                "voice_id": "6889b7f2662160e2caad60e6",
                "weight": 10
            }
        ],
        "pronunciation_dict": {
            "tone" : [
                    "雍容/(yong3)(neng4)",
                    "牡丹/(mu4)(dan3)"
                ]
        },
        "voice_modify": {
            "pitch": 50,
            "intensity": 30,
            "timbre": -50,
            "sound_effects": "robotic"
        },
        "subtitle_enable": true
    }
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/tts", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}',
  'Content-Type' => 'application/json'
];
$body = '{
    "input_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
    "voice_id": "6889b628662160e2caad5dbc",
    "voice_options": {
        "stability": 0.6,
        "similarity_boost": 0.8,
        "style": 1,
        "speed": 1.0,
        "speaker_boost": true,
        "emotion": "happy",
        "volume": 80
    },
    "pitch": -5,
    "webhookUrl": "",
    "language_code": "zh",
    "extra_options": {
        "previous_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "next_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "apply_text_normalization": "auto",
        "apply_language_text_normalization": true,
        "latex_read": true,
        "text_normalization": true,
        "audio_setting": {
            "sample_rate": 24000,
            "bitrate": 32000,
            "format": "mp3",
            "channel": 2
        },
        "timber_weights": [
            {
                "voice_id": "6889b7f4662160e2caad60e9",
                "weight": 80
            },
            {
                "voice_id": "6889b7f3662160e2caad60e8",
                "weight": 60
            },
            {
                "voice_id": "6889b7f3662160e2caad60e7",
                "weight": 30
            },
            {
                "voice_id": "6889b7f2662160e2caad60e6",
                "weight": 10
            }
        ],
        "pronunciation_dict": {
            "tone" : [
                    "雍容/(yong3)(neng4)",
                    "牡丹/(mu4)(dan3)"
                ]
        },
        "voice_modify": {
            "pitch": 50,
            "intensity": 30,
            "timbre": -50,
            "sound_effects": "robotic"
        },
        "subtitle_enable": true
    }
}';
$request = new Request('POST', 'https://openapi.akool.com/api/open/v4/voice/tts', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests
import json

url = "https://openapi.akool.com/api/open/v4/voice/tts"

payload = json.dumps({
    "input_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
    "voice_id": "6889b628662160e2caad5dbc",
    "voice_options": {
        "stability": 0.6,
        "similarity_boost": 0.8,
        "style": 1,
        "speed": 1.0,
        "speaker_boost": true,
        "emotion": "happy",
        "volume": 80
    },
    "pitch": -5,
    "webhookUrl": "",
    "language_code": "zh",
    "extra_options": {
        "previous_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "next_text": "In late spring, the peony garden awakens with layers of petals of the Yao Huang and Wei Zi varieties. When the morning dew has not yet dried, the edges of the petals are glistening with crystal-like droplets, and the inner crimson, like silk, gradually deepens, as if the sunset had been cut into a dress. When the wind blows, the sea of flowers surges, and the golden stamens tremble, releasing a faint fragrance that lures bees and butterflies to swirl around the flower centers in golden vortices. The green peony, in particular, when it first blooms, has tips like jade carvings with a hint of moon white, and when it is in full bloom, it is like an ice wine in an emerald cup, making one suspect it is a divine creation from the Queen Mother's Jade Pool. Occasionally, a petal falls, becoming a rolling agate bead on the embroidered carpet, and even the soil is permeated with the elegant fragrance. Such a captivating beauty is why Liu Yuxi wrote that only the peony is truly the national color, and when it blooms, it moves the entire capital. It uses the entire season's brilliance to interpret the grandeur of being the queen of flowers.",
        "apply_text_normalization": "auto",
        "apply_language_text_normalization": true,
        "latex_read": true,
        "text_normalization": true,
        "audio_setting": {
            "sample_rate": 24000,
            "bitrate": 32000,
            "format": "mp3",
            "channel": 2
        },
        "timber_weights": [
            {
                "voice_id": "6889b7f4662160e2caad60e9",
                "weight": 80
            },
            {
                "voice_id": "6889b7f3662160e2caad60e8",
                "weight": 60
            },
            {
                "voice_id": "6889b7f3662160e2caad60e7",
                "weight": 30
            },
            {
                "voice_id": "6889b7f2662160e2caad60e6",
                "weight": 10
            }
        ],
        "pronunciation_dict": {
            "tone" : [
                    "雍容/(yong3)(neng4)",
                    "牡丹/(mu4)(dan3)"
                ]
        },
        "voice_modify": {
            "pitch": 50,
            "intensity": 30,
            "timbre": -50,
            "sound_effects": "robotic"
        },
        "subtitle_enable": true
    }
})
headers = {
  'x-api-key':'{{API Key}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "create_time": 1751350015709,
        "uid": 101400,
        "team_id": "6805fb69e92d9edc7ca0b409",
        "input_text": "Welcome to the Akool generative AI content creation tool.",
        "preview": null,
        "status": 1,
        "webhookUrl": "",
        "duration": 0,
        "file_name": "1ef1d76ebfc244f7a30430f7049d6ebc.mp3",
        "gender": "Male",
        "deduction_credit": 1.9295,
        "name": "27fec311afd743aa889a057e17e93c13",
        "_id": "68637aff41e5eb74bb8dfe73",
        "voice_model_id": "686379d641e5eb74bb8dfe3f",
        "voice_id": "Tq06jbVyFH4l6R-Gjvo_V-p_nVYk5DRrYJZsxeDmlhEtyhcFKKLQODmgngI9llKw",
        "voice_options": {
            "stability": 0.7,
            "similarity_boost": 0.5,
            "style": 0.6,
            "speed": 0.8,
            "speaker_boost": false,
            "emotion": "happy",
            "volume": 50
        }
    }
}

Create Voice Changer

Only the Akool Multilingual 1 model supports Voice Change.

POST https://openapi.akool.com/api/open/v4/voice/change

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Body Attributes

Parameter	Type	Required	Value	Description
voice_id	String	true		Voice ID， get this voice_id from your cloned voices or akool voice list. getVoiceId
source_voice_file	String	true		Audio file URL, supports mp3, mp4, wav, etc. Must be a public accessible URL, The maximum file size is 50MB.
voice_options	Object	false		Audio settings
- stability	Number	false		Voice stability (0-1) , Supported voice models: Akool Multilingual 1, getVoiceModelName
- similarity_boost	Number	false		Similarity boost (0-1) , Supported voice models: Akool Multilingual 1, getVoiceModelName
- style	Number	false		Voice style (0-1) , Supported voice models: Akool Multilingual 1, Akool Multilingual 2. Style examples: cheerful, getVoiceModelName
- speaker_boost	Boolean	false		Speaker boost, Supported voice models: Akool Multilingual 1, getVoiceModelName
- file_format	String	false	mp3	File format, supports mp3 and wav formats.
- remove_background_noise	Boolean	false	false	Remove background noise, disabled by default
- speed	Number	false	1	Controls the speed of generated audio, default value is 1, available range [0.7, 1.2].
webhookUrl	String	false		Callback url address based on HTTP request
voice_model_name	String	false		The designated model for Clone, Supported voice models: Akool Multilingual 1. getVoiceModelName

Response Attributes

Parameter	Type	Value	Description
code	int	1000	Interface returns business status code(1000:success)
msg	String		Interface returns status information
data	Object		Response data object
- create_time	Long	1751350363707	Creation timestamp
- uid	Integer	101400	User ID
- team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
- preview	String	null	Generated audio URL, this value will be updated after task completion, you can view it in the resourceList. Get Resource List
- source_voice_file	String	”https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3”	Original audio file URL
- status	Integer	1	Voice changer status: 【1:queueing, 2:processing, 3:completed, 4:failed】
- webhookUrl	String	""	Callback URL
- duration	Integer	12800	Audio duration in milliseconds
- file_name	String	”1749098405491-5858-1749019840512audio.mp3”	Generated file name
- gender	String	”Female”	Voice gender
- deduction_credit	Float	0.512	Deducted credits
- name	String	”3f591fc370c542fca9087f124b5ad82b”	Generated name
- _id	String	”68637c5b41e5eb74bb8dfec6”	Document ID
- voice_model_id	String	”67a45479354b7c1fff7e943a”	Voice document ID
- voice_id	String	”hkfHEbBvdQFNX4uWHqRF”	Voice ID
- voice_options	Object		Voice options object
- stability	Number	0.7	Voice stability setting
- similarity_boost	Number	0.5	Similarity boost setting
- style	Number	0.6	Voice style setting
- speaker_boost	Boolean	false	Speaker boost setting

Example

Body

{
    "voice_id": "6889b628662160e2caad5dbc",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "voice_options": {
        "stability": 0.9,
        "similarity_boost": 0.7,
        "style": 1,
        "speaker_boost": false,
        "remove_background_noise": true,
        "speed": 1,
        "file_format": "mp3"
    },
    "voice_model_name": "Akool Multilingual 1",
    "webhookUrl": ""
}

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/change' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
    "voice_id": "6889b628662160e2caad5dbc",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "voice_options": {
        "stability": 0.9,
        "similarity_boost": 0.7,
        "style": 1,
        "speaker_boost": false,
        "remove_background_noise": true,
        "speed": 1,
        "file_format": "mp3"
    },
    "voice_model_name": "Akool Multilingual 1",
    "webhookUrl": ""
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"voice_id\": \"6889b628662160e2caad5dbc\",\n    \"source_voice_file\": \"https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3\",\n    \"voice_options\": {\n        \"stability\": 0.9,\n        \"similarity_boost\": 0.7,\n        \"style\": 1,\n        \"speaker_boost\": false,\n        \"remove_background_noise\": true,\n        \"speed\": 1,\n        \"file_format\": \"mp3\"\n    },\n    \"voice_model_name\": \"Akool Multilingual 1\",\n    \"webhookUrl\": \"\"\n}");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/change")
  .method("POST", body)
  .addHeader("x-api-key", "{{API Key}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
    "voice_id": "6889b628662160e2caad5dbc",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "voice_options": {
        "stability": 0.9,
        "similarity_boost": 0.7,
        "style": 1,
        "speaker_boost": false,
        "remove_background_noise": true,
        "speed": 1,
        "file_format": "mp3"
    },
    "voice_model_name": "Akool Multilingual 1",
    "webhookUrl": ""
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/change", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}',
  'Content-Type' => 'application/json'
];
$body = '{
    "voice_id": "6889b628662160e2caad5dbc",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "voice_options": {
        "stability": 0.9,
        "similarity_boost": 0.7,
        "style": 1,
        "speaker_boost": false,
        "remove_background_noise": true,
        "speed": 1,
        "file_format": "mp3"
    },
    "voice_model_name": "Akool Multilingual 1",
    "webhookUrl": ""
}';
$request = new Request('POST', 'https://openapi.akool.com/api/open/v4/voice/change', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests
import json

url = "https://openapi.akool.com/api/open/v4/voice/change"

payload = json.dumps({
    "voice_id": "6889b628662160e2caad5dbc",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "voice_options": {
        "stability": 0.9,
        "similarity_boost": 0.7,
        "style": 1,
        "speaker_boost": false,
        "remove_background_noise": true,
        "speed": 1,
        "file_format": "mp3"
    },
    "voice_model_name": "Akool Multilingual 1",
    "webhookUrl": ""
})
headers = {
  'x-api-key':'{{API Key}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Response

{
  "code": 1000,
  "msg": "OK",
  "data": {
    "create_time": 1751350363707,
    "uid": 101400,
    "team_id": "6805fb69e92d9edc7ca0b409",
    "source_voice_file": "https://drz0f01yeq1cx.cloudfront.net/1749098405491-5858-1749019840512audio.mp3",
    "preview": null,
    "status": 1,
    "webhookUrl": "",
    "duration": 12800,
    "file_name": "1749098405491-5858-1749019840512audio.mp3",
    "gender": "Female",
    "deduction_credit": 0.512,
    "name": "3f591fc370c542fca9087f124b5ad82b",
    "_id": "68637c5b41e5eb74bb8dfec6",
    "voice_model_id": "67a45479354b7c1fff7e943a",
    "voice_id": "hkfHEbBvdQFNX4uWHqRF",
    "voice_options": {
      "stability": 0.7,
      "similarity_boost": 0.5,
      "style": 0.6,
      "speaker_boost": false
    }
  }
}

Get Voice Results List

GET https://openapi.akool.com/api/open/v4/voice/resource/list

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Query Attributes

Parameter	Type	Required	Value	Description
type	String	true	1,2	1-voiceTTS, 2-voiceChanger
page	String	false	1	Page number
size	String	false	10	Page size

Response Attributes

Parameter	Type	Value	Description
code	Integer	1000	API returns status code(1000:success)
msg	String		API returns status message
data	Object		Response data object
- result	Array		Voice resource list
— _id	String	”68637c5b41e5eb74bb8dfec6”	Document ID
— create_time	Long	1751350363707	Creation timestamp
— update_time	Long	1751350368468	Update timestamp
— uid	Integer	101400	User ID
— team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
— rate	String	”100%“	Processing rate
— preview	String	”https://drz0f01yeq1cx.cloudfront.net/…”	Generated audio URL
— status	Integer	3	Status: 【1:queueing, 2:processing, 3:completed, 4:failed】
— webhookUrl	String	""	Callback URL
— duration	Integer	12852	Audio duration in milliseconds
— file_name	String	”1749098405491-5858-1749019840512audio.mp3”	File name
— gender	String	”Female”	Voice gender
— deduction_credit	Float	0.9295	Deducted credits
— name	String	”3f591fc370c542fca9087f124b5ad82b”	Resource name
— input_text	String	”Słyszę, że chcesz leżeć płasko? Gratulacje — przynajmniej zrozumiałeś grawitację! “	Text to Speech trial listening text
— __v	Integer	0	Version number
- count	Integer	1	Total count of resources
- page	Integer	1	Current page number
- size	Integer	10	Page size

Example

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/resource/list?type=1&page=1&size=10' \
--header 'x-api-key: {{API Key}}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/resource/list?type=1&page=1&size=10")
  .method("GET", body)
  .addHeader("x-api-key", "{{API Key}}")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/resource/list?type=1&page=1&size=10", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}'
];
$request = new Request('GET', 'https://openapi.akool.com/api/open/v4/voice/resource/list?type=1&page=1&size=10', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests

url = "https://openapi.akool.com/api/open/v4/voice/resource/list?type=1&page=1&size=10"

payload = {}
headers = {
  'x-api-key':'{{API Key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "result": [
            {
                "_id": "68637c5b41e5eb74bb8dfec6",
                "create_time": 1751350363707,
                "update_time": 1751350368468,
                "uid": 101400,
                "team_id": "6805fb69e92d9edc7ca0b409",
                "rate": "100%",
                "preview": "https://drz0f01yeq1cx.cloudfront.net/1751350368172-audio.mp3",
                "status": 3,
                "webhookUrl": "",
                "duration": 12852,
                "file_name": "1749098405491-5858-1749019840512audio.mp3",
                "gender": "Female",
                "deduction_credit": 0.9295,
                "name": "3f591fc370c542fca9087f124b5ad82b",
                "input_text": "Słyszę, że chcesz leżeć płasko? Gratulacje — przynajmniej zrozumiałeś grawitację! ",
                "__v": 0
            }
        ],
        "count": 1,
        "page": 1,
        "size": 10
    }
}

Get Voice List

GET https://openapi.akool.com/api/open/v4/voice/list

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Query Attributes

Parameter	Type	Required	Value	Description
type	String	true	1,2	1-VoiceClone, 2-Akool Voices
page	String	false	1	Page number
size	String	false	10	Page size
style	String	false	Calm,Authoritative	Voice style filters, separated by commas
gender	String	false	Male,Female	Gender filters, separated by commas
age	String	false	Young,Middle,Elderly	Age filters, separated by commas
scenario	String	false	Advertisement,Education	Scenario filters, separated by commas
name	String	false	MyVoice	Voice name, supports fuzzy search
support_stream	Integer	false	1	2-Voice does not support streaming.； 1-Voice supports streaming.

Response Attributes

Parameter	Type	Value	Description
code	Integer	1000	API returns status code(1000:success)
msg	String		API returns status message
data	Object		Response data object
- result	Array		Voice list
— _id	String	”68676e544439e3b8e246a077”	Document ID
— uid	Integer	101400	User ID
— team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
— voice_id	String	”zQAGCFElz23u6Brdj4L-NrbEmSxswXdoPN_GBpYgUPHo1EGWgZgAnFJexONx_jGy”	Voice ID
— gender	String	”Male”	Voice gender
— language	String	”Polish”	Voice language
— locale	String	”pl”	Voice locale
— name	String	”MyVoice0626-01”	Voice name
— preview	String	”https://d2qf6ukcym4kn9.cloudfront.net/…”	Preview audio URL
— text	String	”This is a comic style model…”	Preview text content
— duration	Integer	9822	Audio duration in milliseconds
— status	Integer	3	Voice status: 【1:queueing, 2:processing, 3:completed, 4:failed】
— create_time	Long	1751608916162	Creation timestamp
— update_time	Long	1751608916162	Update timestamp
— style	Array	[“Authoritative”, “Calm”]	Voice style tags
— scenario	Array	[“Advertisement”]	Scenario tags
— age	Array	[“Elderly”, “Middle”]	Age tags
— deduction_credit	Integer	0	Deducted credits
— webhookUrl	String	""	Callback URL
— voice_model_name	String	”Akool Multilingual 3”	Supported voice model name
— support_stream	Boolean	true	Supported stream: true/false, Akool Multilingual 1 & Akool Multilingual 3 only support stream.
- count	Integer	9	Total count of voices
- page	Integer	1	Current page number
- size	Integer	1	Page size

Example

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/list?type=1&page=1&size=10&style=Calm,Authoritative&gender=Male&name=MyVoice' \
--header 'x-api-key: {{API Key}}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/list?type=1&page=1&size=10&style=Calm,Authoritative&gender=Male&name=MyVoice")
  .method("GET", body)
  .addHeader("x-api-key", "{{API Key}}")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/list?type=1&page=1&size=10&style=Calm,Authoritative&gender=Male&name=MyVoice", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}'
];
$request = new Request('GET', 'https://openapi.akool.com/api/open/v4/voice/list?type=1&page=1&size=10&style=Calm,Authoritative&gender=Male&name=MyVoice', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests

url = "https://openapi.akool.com/api/open/v4/voice/list"

payload = {}
headers = {
  'x-api-key':'{{API Key}}'
}

params = {
  'type': '1',
  'page': '1',
  'size': '10',
  'style': 'Calm,Authoritative',
  'gender': 'Male',
  'name': 'MyVoice'
}

response = requests.request("GET", url, headers=headers, data=payload, params=params)

print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "result": [
            {
                "_id": "68676e544439e3b8e246a077",
                "uid": 101400,
                "team_id": "6805fb69e92d9edc7ca0b409",
                "voice_id": "zQAGCFElz23u6Brdj4L-NrbEmSxswXdoPN_GBpYgUPHo1EGWgZgAnFJexONx_jGy",
                "gender": "Male",
                "language": "Polish",
                "locale": "pl",
                "name": "MyVoice0626-01",
                "preview": "https://d2qf6ukcym4kn9.cloudfront.net/1751608955706-c1cf1692-fd47-417c-b18a-dcbbb93360fa-2756.mp3",
                "text": "This is a comic style model, this is a comic style model, this is a comic style model, this is a comic style model",
                "duration": 9822,
                "status": 3,
                "create_time": 1751608916162,
                "style": [
                    "Authoritative",
                    "Calm"
                ],
                "scenario": [
                    "Advertisement"
                ],
                "age": [
                    "Elderly",
                    "Middle"
                ],
                "deduction_credit": 0,
                "webhookUrl": "",
                "voice_model_name": "Akool Multilingual 3",
                "support_stream": true
            }
        ],
        "count": 9,
        "page": 1,
        "size": 1
    }
}

Delete Voice

POST https://openapi.akool.com/api/open/v4/voice/del

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Body Attributes

Parameter	Type	Required	Value	Description
_ids	Array	true		Voice list document IDs Get Voice Document ID

Response Attributes

Parameter	Type	Value	Description
code	integer	1000	API returns status code(1000:success)
msg	String		API returns status message
data	Object		Response data object
- successIds	Array		Deleted voice document IDs
- noPermissionVoices	Array		Delete failed voice document msg list
- _id	String	6881cd86618fa41c89557b0c	Delete failed voice document ID
- msg	String	VoiceId:6881cd86618fa41c89557b0c resource not found	Delete failed voice error msg

Example

Body

{
    "_ids": [
        "6836b8183a59f36196bb9c52",
        "6836ba935026505ab7a529ce"
    ]
}

Request

curl --location --request POST 'https://openapi.akool.com/api/open/v4/voice/del' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
    "_ids": [
        "6836b8183a59f36196bb9c52",
        "6836ba935026505ab7a529ce"
    ]
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"_ids\": [\n        \"6836b8183a59f36196bb9c52\",\n        \"6836ba935026505ab7a529ce\"\n    ]\n}");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/del")
  .method("POST", body)
  .addHeader("x-api-key", "{{API Key}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "_ids": [
    "6836b8183a59f36196bb9c52",
    "6836ba935026505ab7a529ce"
  ]
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/del", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}',
  'Content-Type' => 'application/json'
];
$body = '{
  "_ids": [
    "6836b8183a59f36196bb9c52",
    "6836ba935026505ab7a529ce"
  ]
}';
$request = new Request('POST', 'https://openapi.akool.com/api/open/v4/voice/del', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests
import json

url = "https://openapi.akool.com/api/open/v4/voice/del"

payload = json.dumps({
  "_ids": [
    "6836b8183a59f36196bb9c52",
    "6836ba935026505ab7a529ce"
  ]
})
headers = {
  'x-api-key':'{{API Key}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

Response

{
    "code": 1000,
    "msg": "Delete voice successfully",
    "data": {
        "successIds": [
            "6882f4c10529ae771e71531d"
        ],
        "noPermissionVoices": [
            {
                "_id": "6881cd86618fa41c89557b0c",
                "msg": "VoiceId:6881cd86618fa41c89557b0c resource not found"
            }
        ]
    }
}

Get Voice Detail

GET https://openapi.akool.com/api/open/v4/voice/detail/{_id}

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Path Attributes

Parameter	Type	Required	Value	Description
_id	String	true		Voice list document IDs Get Voice Document ID

Response Attributes

Parameter	Type	Value	Description
code	Integer	1000	API returns status code(1000:success)
msg	String		API returns status message
data	Object		Response data object
- _id	String	”6836bafb5026505ab7a529fa”	Document ID
- uid	Integer	101400	User ID
- team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
- voice_id	String	”yRBw4OM8YFm5pCNKxJQ7”	Voice ID
- gender	String	”Male”	Voice gender
- name	String	”Snow Peak 01”	Voice name
- preview	String	”https://drz0f01yeq1cx.cloudfront.net/…”	Preview audio URL
- text	String	”Hello, I’m your personalized AI voice…”	Preview text content
- duration	Integer	7055	Audio duration in milliseconds
- status	Integer	3	Voice status: 【1:queueing, 2:processing, 3:completed, 4:failed】
- create_time	Long	1748417275493	Creation timestamp
- style	Array	[“Authoritative”, “Calm”]	Voice style tags
- scenario	Array	[“Advertisement”]	Scenario tags
- age	Array	[“Elderly”, “Middle”]	Age tags
- deduction_credit	Integer	0	Deducted credits
- voice_model_name	String	”Akool Multilingual 1”	Supported voice model name
- support_stream	Boolean	true	Supported stream: true/false, Akool Multilingual 1 & Akool Multilingual 3 only support stream.
- language	String	”Chinese”	Voice language
- locale	String	”zh”	Voice locale
- update_time	Long	1751608916162	Update timestamp

Example

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/detail/6836bafb5026505ab7a529fa' \
--header 'x-api-key: {{API Key}}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/detail/6836bafb5026505ab7a529fa")
  .method("GET", body)
  .addHeader("x-api-key", "{{API Key}}")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/detail/6836bafb5026505ab7a529fa", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}'
];
$request = new Request('GET', 'https://openapi.akool.com/api/open/v4/voice/detail/6836bafb5026505ab7a529fa', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests

url = "https://openapi.akool.com/api/open/v4/voice/detail/6836bafb5026505ab7a529fa"

payload = {}
headers = {
  'x-api-key':'{{API Key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "_id": "6882f23c0529ae771e7152dc",
        "uid": 101400,
        "team_id": "6805fb69e92d9edc7ca0b409",
        "voice_id": "kfr_1wGPuauzcSOZgpBGLd_ApviIHqMIZ5bS2OeMiMkvId0eAMkq1ii8rvInZ2pE",
        "gender": "Male",
        "name": "zhongwen-072501",
        "preview": "https://drz0f01yeq1cx.cloudfront.net/1753412190380-sample.mp3",
        "text": "人生就像登山，重要的不是顶峰的高度，而是攀登时的姿态。当你觉得脚步沉重时，请记住：竹子用四年时间仅生长3厘米，但从第五年开始，每天以30厘米的速度疯长。那些看似微不足道的积累，终将在某个转角绽放光芒。前路或许泥泞，但每个坚持的脚印都在书写传奇；黑夜也许漫长，但晨光总在咬牙坚持后准时降临。正如海明威所说：人可以被毁灭，但不能被打败。2025年的今天，愿你把挫折当作垫脚石，让汗水成为勋章，因为这个世界永远奖励那些在跌倒后依然选择起身奔跑的人。",
        "duration": 55353,
        "status": 3,
        "create_time": 1753412156588,
        "style": [
            "Authoritative",
            "Calm"
        ],
        "scenario": [
            "Advertisenment"
        ],
        "age": [
            "Elderly",
            "Middle"
        ],
        "deduction_credit": 0,
        "webhookUrl": "",
        "language": "Chinese",
        "locale": "zh",
        "voice_model_name": "Akool Multilingual 3",
        "support_stream": true
    }
}

Get Voice Result Detail

GET https://openapi.akool.com/api/open/v4/voice/resource/detail/{_id}

Request Headers

Parameter	Value	Description
x-api-key	API Key	Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
Authorization	Bearer `{token}`	Your API Key used for request authorization.Get Token.

Path Attributes

Parameter	Type	Required	Value	Description
_id	String	true		Voice result document ID Get Voice Result ID

Response Attributes

Parameter	Type	Value	Description
code	Integer	1000	API returns status code(1000:success)
msg	String		API returns status message
data	Object		Response data object
- result	Object		Voice result object
— _id	String	”688afbd9d2b4b269d1123ffb”	Document ID
— create_time	Long	1753938905005	Creation timestamp
— update_time	Long	0	Update timestamp
— uid	Integer	101400	User ID
— team_id	String	”6805fb69e92d9edc7ca0b409”	Team ID
— input_text	String	”Życie jak wspinaczka górska…”	Input text content
— rate	String	”100%“	Processing rate
— status	Integer	1	Status: 【1:queueing, 2:processing, 3:completed, 4:failed】
— webhookUrl	String	""	Callback URL
— duration	Integer	0	Audio duration in milliseconds
— file_name	String	”1753938905005.mp3”	File name
— gender	String	”Male”	Voice gender
— deduction_credit	Float	0.5148	Deducted credits
— name	String	”26ca668a9eb448b7b9a3806fa86207f3”	Resource name
— priority	Integer	2	Priority level
— language_code	String	”pt”	Language code
— __v	Integer	0	Version number
— preview	String	null	Preview audio URL

Example

Request

curl --location 'https://openapi.akool.com/api/open/v4/voice/resource/detail/688afbd9d2b4b269d1123ffb' \
--header 'x-api-key: {{API Key}}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://openapi.akool.com/api/open/v4/voice/resource/detail/688afbd9d2b4b269d1123ffb")
  .method("GET", body)
  .addHeader("x-api-key", "{{API Key}}")
  .build();
Response response = client.newCall(request).execute();

const myHeaders = new Headers();
myHeaders.append("x-api-key", "{{API Key}}");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://openapi.akool.com/api/open/v4/voice/resource/detail/688afbd9d2b4b269d1123ffb", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$client = new Client();
$headers = [
  'x-api-key' =>'{{API Key}}'
];
$request = new Request('GET', 'https://openapi.akool.com/api/open/v4/voice/resource/detail/688afbd9d2b4b269d1123ffb', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

import requests

url = "https://openapi.akool.com/api/open/v4/voice/resource/detail/688afbd9d2b4b269d1123ffb"

payload = {}
headers = {
  'x-api-key':'{{API Key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Response

{
    "code": 1000,
    "msg": "OK",
    "data": {
        "result": {
            "_id": "688afbd9d2b4b269d1123ffb",
            "create_time": 1753938905005,
            "update_time": 0,
            "uid": 101400,
            "team_id": "6805fb69e92d9edc7ca0b409",
            "input_text": "Życie jak wspinaczka górska: ważniejsza od wysokości szczytu jest postawa, z jaką się wspinasz. Gdy czujesz, że stopy",
            "rate": "100%",
            "status": 1,
            "webhookUrl": "",
            "duration": 0,
            "file_name": "1753938905005.mp3",
            "gender": "Male",
            "deduction_credit": 0.5148,
            "name": "26ca668a9eb448b7b9a3806fa86207f3",
            "priority": 2,
            "language_code": "pt",
            "__v": 0,
            "preview": null
        }
    }
}

​Rates

​Models

​Create Voice Clone

​Example

​Create Text to Speech

​Example

​Create Voice Changer

​Example

​Get Voice Results List

​Example

​Get Voice List

​Example

​Delete Voice

​Example

​Get Voice Detail

​Example

​Get Voice Result Detail

​Example

Rates

Models

Create Voice Clone

Example

Create Text to Speech

Example

Create Voice Changer

Example

Get Voice Results List

Example

Get Voice List

Example

Delete Voice

Example

Get Voice Detail

Example

Get Voice Result Detail

Example