Vai alla navigazione

Crea progetto Studio

Crea un nuovo progetto Studio, che può essere inizializzato vuoto, da un documento o da un URL.

Header

xi-api-keystringOpzionale

Richiesta

This endpoint expects a multipart form containing an optional file.
namestringObbligatorio
Il nome del progetto Studio, usato solo a scopo identificativo.
default_title_voice_idstring or nullOpzionale

Il voice_id corrispondente alla voce predefinita usata per i nuovi titoli.

default_paragraph_voice_idstring or nullOpzionale

Il voice_id corrispondente alla voce predefinita usata per i nuovi paragrafi.

default_model_idstring or nullOpzionale

L’ID del modello da usare per questo progetto Studio. Puoi eseguire una query GET /v1/models per elencare tutti i modelli disponibili.

from_urlstring or nullOpzionale

Un URL facoltativo da cui estrarremo il contenuto per inizializzare il progetto Studio. Se questo valore è impostato, ‘from_url’ e ‘from_content’ devono essere null. Se non vengono forniti ‘from_url’, ‘from_document’ né ‘from_content’, inizializzeremo il progetto Studio vuoto.

from_documentfileOpzionale

Puoi fornire un file facoltativo .epub, .pdf, .txt o simile. Se fornito, inizializzeremo il progetto Studio con il suo contenuto. Se questo valore è impostato, ‘from_url’ e ‘from_content’ devono essere null. Se non vengono forniti ‘from_url’, ‘from_document’ né ‘from_content’, inizializzeremo il progetto Studio vuoto.

from_content_jsonstringOpzionale

Contenuto facoltativo con cui inizializzare il progetto Studio. Se impostato, ‘from_url’ e ‘from_document’ devono essere null. Se non vengono forniti né ‘from_url’, né ‘from_document’, né ‘from_content’, inizializzeremo il progetto Studio vuoto.

Esempio: [{“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 nullOpzionale

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.

Valori consentiti:
titlestring or nullOpzionale

Un nome facoltativo dell’autore del progetto Studio; verrà aggiunto come metadato al file mp3 durante il download del progetto Studio o del capitolo.

authorstring or nullOpzionale

Un nome facoltativo dell’autore del progetto Studio; verrà aggiunto come metadato al file mp3 durante il download del progetto Studio o del capitolo.

descriptionstring or nullOpzionale
Una descrizione facoltativa del progetto Studio.
genreslist of stringsOpzionale
Un elenco facoltativo di generi associati al progetto Studio.
target_audienceenum or nullOpzionale
Un pubblico di destinazione facoltativo del progetto Studio.
Valori consentiti:
languagestring or nullOpzionale=2 characters

Una lingua facoltativa del progetto Studio. Codice lingua di due lettere (ISO 639-1).

content_typestring or nullOpzionale
Un tipo di contenuto facoltativo del progetto Studio.
original_publication_datestring or nullOpzionaleformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"

Una data di pubblicazione originale facoltativa del progetto Studio, nel formato YYYY-MM-DD o YYYY.

mature_contentboolean or nullOpzionalePredefinito a false
Un'indicazione facoltativa che specifica se questo progetto Studio contiene contenuti per adulti.
isbn_numberstring or nullOpzionale

Un numero ISBN facoltativo del progetto Studio che vuoi creare; verrà aggiunto come metadato al file mp3 durante il download del progetto Studio o del capitolo.

acx_volume_normalizationbooleanOpzionalePredefinito a false

[Obsoleto] Quando il progetto Studio viene scaricato, indica se l’audio restituito deve essere sottoposto a post-elaborazione per rispettare i requisiti di volume normalizzato degli audiolibri.

volume_normalizationbooleanOpzionalePredefinito a false

Se, quando il progetto Studio viene scaricato, l’audio restituito deve avere un post-processing per rispettare i requisiti di volume normalizzato degli audiolibri

pronunciation_dictionary_locatorslist of stringsOpzionale

Un elenco di locator dei dizionari di pronuncia (pronunciation_dictionary_id, version_id), codificati come elenco di stringhe JSON, da applicare al testo. È richiesto un elenco di stringhe codificate in JSON poiché l’aggiunta di progetti può avvenire tramite formData anziché jsonBody. Per specificare più dizionari, usa più righe —form nel comando curl, ad esempio —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 nullOpzionale

Un URL che verrà chiamato dal nostro servizio quando il progetto Studio viene convertito. La richiesta conterrà un blob JSON con lo stato della conversione. Messaggi:

  1. Quando il progetto è stato convertito correttamente: { 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. Quando la conversione del progetto non è riuscita: { type: “project_conversion_status”, event_timestamp: 1234567890, data: { request_id: “1234567890”, project_id: “21m00Tcm4TlvDq8ikWAM”, conversion_status: “error”, project_snapshot_id: None, error_details: “Dettagli dell’errore se la conversione non è riuscita” } }

  3. Quando il capitolo è stato convertito correttamente: { 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. Quando la conversione del capitolo non è riuscita: { 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: “Dettagli dell’errore se la conversione non è riuscita” } }

fictionenum or nullOpzionale

Un’indicazione facoltativa che specifica se il contenuto di questo progetto Studio è di finzione.

Valori consentiti:
apply_text_normalizationenum or nullOpzionale

Questo parametro controlla la normalizzazione del testo con quattro modalità: ‘auto’, ‘on’, ‘apply_english’ e ‘off’. Se impostato su ‘auto’, il sistema deciderà automaticamente se applicare la normalizzazione del testo (ad esempio, scrivendo i numeri in lettere). Con ‘on’, la normalizzazione del testo verrà sempre applicata, mentre con ‘off’ verrà ignorata. ‘apply_english’ equivale a ‘on’, ma presume che il testo sia in inglese.

Valori consentiti:
auto_convertbooleanOpzionalePredefinito a false
Indica se convertire automaticamente il progetto Studio in audio.
auto_assign_voicesboolean or nullOpzionalePredefinito a false

[Funzionalità alfa] Indica se assegnare automaticamente le voci alle frasi durante la creazione del progetto.

source_typeenum or nullOpzionale
Il tipo di progetto Studio da creare.
voice_settingslist of stringsOpzionale

Override facoltativi delle impostazioni vocali per il progetto, codificati come elenco di stringhe JSON.

Esempio: [”{“voice_id”: “21m00Tcm4TlvDq8ikWAM”, “stability”: 0.7, “similarity_boost”: 0.8, “style”: 0.5, “speed”: 1.0, “use_speaker_boost”: true}”]

create_publishing_readboolean or nullOpzionalePredefinito a false
Se true, crea una lettura corrispondente per la pubblicazione diretta in stato di bozza.

Risposta

Risposta riuscita
projectobject

Errori

422
Unprocessable Entity Error