For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Tworzy nowy projekt Studio, który można zainicjować jako pusty, z dokumentu lub z adresu URL.
Nagłówki
xi-api-keystringOpcjonalny
Żądanie
This endpoint expects a multipart form containing an optional file.
namestringWymagany
Nazwa projektu Studio używana tylko do identyfikacji.
default_title_voice_idstring or nullOpcjonalny
voice_id odpowiadające domyślnemu głosowi używanemu w nowych tytułach.
default_paragraph_voice_idstring or nullOpcjonalny
voice_id odpowiadające domyślnemu głosowi używanemu w nowych akapitach.
default_model_idstring or nullOpcjonalny
ID modelu do użycia w tym projekcie Studio; użyj GET /v1/models, aby wyświetlić wszystkie dostępne modele.
from_urlstring or nullOpcjonalny
Opcjonalny URL, z którego pobierzemy treść do inicjalizacji projektu Studio. Jeśli ta wartość jest ustawiona, „from_url” i „from_content” muszą mieć wartość null. Jeśli nie podasz „from_url”, „from_document” ani „from_content”, zainicjalizujemy pusty projekt Studio.
from_documentfileOpcjonalny
Możesz podać opcjonalny plik .epub, .pdf, .txt lub podobny. Jeśli go podasz, zainicjalizujemy projekt Studio jego treścią. Jeśli ta wartość jest ustawiona, „from_url” i „from_content” muszą mieć wartość null. Jeśli nie podasz „from_url”, „from_document” ani „from_content”, zainicjalizujemy pusty projekt Studio.
from_content_jsonstringOpcjonalny
Opcjonalna zawartość, która posłuży do inicjalizacji projektu Studio. Jeśli ją podasz, 'from_url' i 'from_document' muszą mieć wartość null. Jeśli nie podasz żadnego z pól 'from_url', 'from_document' ani 'from_content', zainicjalizujemy pusty projekt Studio.
Przykład:
[{"name": "Chapter A", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "A", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "B", "type": "tts_node"}]}, {"sub_type": "h1", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "C", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "D", "type": "tts_node"}]}]}, {"name": "Chapter B", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "E", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "F", "type": "tts_node"}]}, {"sub_type": "h2", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "G", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "H", "type": "tts_node"}]}]}]
quality_presetenum or nullOpcjonalny
Output quality of the generated audio. Must be one of:
'standard' - standard output format, 128kbps with 44.1kHz sample rate.
'high' - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side.
'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
If not provided, defaults to the highest quality preset available on your subscription tier.
Dozwolone wartości:
titlestring or nullOpcjonalny
Opcjonalne imię i nazwisko autora projektu Studio. Zostanie dodane jako metadane do pliku MP3 pobieranego dla projektu Studio lub rozdziału.
authorstring or nullOpcjonalny
Opcjonalne imię i nazwisko autora projektu Studio. Zostanie dodane jako metadane do pliku MP3 pobieranego dla projektu Studio lub rozdziału.
descriptionstring or nullOpcjonalny
Opcjonalny opis projektu Studio.
genreslist of stringsOpcjonalny
Opcjonalna lista gatunków powiązanych z projektem Studio.
target_audienceenum or nullOpcjonalny
Opcjonalna grupa docelowa projektu Studio.
Dozwolone wartości:
languagestring or nullOpcjonalny=2 characters
Opcjonalny język projektu Studio. Dwuliterowy kod języka (ISO 639-1).
content_typestring or nullOpcjonalny
Opcjonalny typ treści projektu Studio.
original_publication_datestring or nullOpcjonalnyformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"
Opcjonalna data pierwszej publikacji projektu Studio w formacie YYYY-MM-DD lub YYYY.
mature_contentboolean or nullOpcjonalnyDomyślnie false
Opcjonalne określenie, czy ten projekt Studio zawiera treści dla dorosłych.
isbn_numberstring or nullOpcjonalny
Opcjonalny numer ISBN tworzonego projektu Studio. Zostanie dodany jako metadane do pliku MP3 pobieranego dla projektu Studio lub rozdziału.
[Wycofane] Określa, czy po pobraniu projektu Studio zwrócone audio powinno przejść postprocessing, aby spełniało wymagania dotyczące znormalizowanej głośności audiobooków.
Czy podczas pobierania projektu Studio zwrócone audio powinno być poddane postprocessingowi, aby spełniało wymagania dotyczące znormalizowanej głośności audiobooków
pronunciation_dictionary_locatorslist of stringsOpcjonalny
Lista lokalizatorów słowników wymowy (pronunciation_dictionary_id, version_id) zakodowanych jako lista ciągów JSON dla słowników wymowy stosowanych do tekstu. Lista ciągów zakodowanych w JSON jest wymagana, ponieważ projekty można dodawać przez formData zamiast jsonBody. Aby podać kilka słowników, użyj kilku wierszy --form w curl, na przykład --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'.
callback_urlstring or nullOpcjonalny
Adres URL wywoływany przez naszą usługę po przekonwertowaniu projektu Studio. Żądanie będzie zawierać obiekt JSON ze statusem konwersji.
Komunikaty:
1. Gdy projekt został pomyślnie przekonwertowany:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "success",
project_snapshot_id: "22m00Tcm4TlvDq8ikMAT",
error_details: None,
}
}
2. Gdy konwersja projektu się nie powiodła:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "error",
project_snapshot_id: None,
error_details: "Szczegóły błędu, jeśli konwersja się nie powiodła"
}
}
3. Gdy rozdział został pomyślnie przekonwertowany:
{
type: "chapter_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
chapter_id: "22m00Tcm4TlvDq8ikMAT",
conversion_status: "success",
chapter_snapshot_id: "23m00Tcm4TlvDq8ikMAV",
error_details: None,
}
}
4. Gdy konwersja rozdziału się nie powiodła:
{
type: "chapter_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
chapter_id: "22m00Tcm4TlvDq8ikMAT",
conversion_status: "error",
chapter_snapshot_id: None,
error_details: "Szczegóły błędu, jeśli konwersja się nie powiodła"
}
}
fictionenum or nullOpcjonalny
Opcjonalne określenie, czy treść tego projektu Studio jest fikcją.
Dozwolone wartości:
apply_text_normalizationenum or nullOpcjonalny
Ten parametr steruje normalizacją tekstu w czterech trybach: 'auto', 'on', 'apply_english' i 'off'.
Przy wartości 'auto' system automatycznie zdecyduje, czy zastosować normalizację tekstu
(np. zapis liczb słownie). Przy 'on' normalizacja tekstu będzie zawsze stosowana, a
przy 'off' zostanie pominięta. 'apply_english' działa tak samo jak 'on', ale zakłada, że tekst jest po angielsku.
Dozwolone wartości:
auto_convertbooleanOpcjonalnyDomyślnie false
Czy automatycznie konwertować projekt Studio na audio.
auto_assign_voicesboolean or nullOpcjonalnyDomyślnie false
[Funkcja alfa] Określa, czy automatycznie przypisywać głosy do fraz podczas tworzenia projektu.
source_typeenum or nullOpcjonalny
Typ projektu Studio do utworzenia.
voice_settingslist of stringsOpcjonalny
Opcjonalne nadpisania ustawień głosu dla projektu, zakodowane jako lista ciągów JSON.
Możesz podać opcjonalny plik .epub, .pdf, .txt lub podobny. Jeśli go podasz, zainicjalizujemy projekt Studio jego treścią. Jeśli ta wartość jest ustawiona, „from_url” i „from_content” muszą mieć wartość null. Jeśli nie podasz „from_url”, „from_document” ani „from_content”, zainicjalizujemy pusty projekt Studio.
Opcjonalna zawartość, która posłuży do inicjalizacji projektu Studio. Jeśli ją podasz, ‘from_url’ i ‘from_document’ muszą mieć wartość null. Jeśli nie podasz żadnego z pól ‘from_url’, ‘from_document’ ani ‘from_content’, zainicjalizujemy pusty projekt Studio.
Output quality of the generated audio. Must be one of:
‘standard’ - standard output format, 128kbps with 44.1kHz sample rate.
‘high’ - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side.
‘ultra’ - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
‘ultra_lossless’ - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
If not provided, defaults to the highest quality preset available on your subscription tier.
Lista lokalizatorów słowników wymowy (pronunciation_dictionary_id, version_id) zakodowanych jako lista ciągów JSON dla słowników wymowy stosowanych do tekstu. Lista ciągów zakodowanych w JSON jest wymagana, ponieważ projekty można dodawać przez formData zamiast jsonBody. Aby podać kilka słowników, użyj kilku wierszy —form w curl, na przykład —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’.
Adres URL wywoływany przez naszą usługę po przekonwertowaniu projektu Studio. Żądanie będzie zawierać obiekt JSON ze statusem konwersji.
Komunikaty:
Gdy projekt został pomyślnie przekonwertowany:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “success”,
project_snapshot_id: “22m00Tcm4TlvDq8ikMAT”,
error_details: None,
}
}
Gdy konwersja projektu się nie powiodła:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “error”,
project_snapshot_id: None,
error_details: “Szczegóły błędu, jeśli konwersja się nie powiodła”
}
}
Gdy konwersja rozdziału się nie powiodła:
{
type: “chapter_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
chapter_id: “22m00Tcm4TlvDq8ikMAT”,
conversion_status: “error”,
chapter_snapshot_id: None,
error_details: “Szczegóły błędu, jeśli konwersja się nie powiodła”
}
}
Ten parametr steruje normalizacją tekstu w czterech trybach: ‘auto’, ‘on’, ‘apply_english’ i ‘off’.
Przy wartości ‘auto’ system automatycznie zdecyduje, czy zastosować normalizację tekstu
(np. zapis liczb słownie). Przy ‘on’ normalizacja tekstu będzie zawsze stosowana, a
przy ‘off’ zostanie pominięta. ‘apply_english’ działa tak samo jak ‘on’, ale zakłada, że tekst jest po angielsku.
