Hoppa till navigering

Skapa Studio-projekt

Skapar ett nytt Studio-projekt som kan initieras tomt, från ett dokument eller från en URL.

Headers

xi-api-keystringValfri

Förfrågan

This endpoint expects a multipart form containing an optional file.
namestringObligatorisk

Namnet på Studio-projektet, används endast för identifiering.

default_title_voice_idstring or nullValfri

voice_id som motsvarar standardrösten för nya rubriker.

default_paragraph_voice_idstring or nullValfri

voice_id som motsvarar standardrösten för nya stycken.

default_model_idstring or nullValfri

ID:t för modellen som ska användas för detta Studio-projekt. Du kan anropa GET /v1/models för att lista alla tillgängliga modeller.

from_urlstring or nullValfri

En valfri URL från vilken vi hämtar innehåll för att initialisera Studio-projektet. Om detta anges måste 'from_url' och 'from_content' vara null. Om varken 'from_url', 'from_document' eller 'from_content' anges initialiserar vi Studio-projektet som tomt.

from_documentfileValfri

En valfri .epub-, .pdf-, .txt- eller liknande fil kan anges. Om den anges initialiserar vi Studio-projektet med dess innehåll. Om detta anges måste 'from_url' och 'from_content' vara null. Om varken 'from_url', 'from_document' eller 'from_content' anges initialiserar vi Studio-projektet som tomt.

from_content_jsonstringValfri

Valfritt innehåll att initiera Studio-projektet med. Om detta anges måste 'from_url' och 'from_document' vara null. Om varken 'from_url', 'from_document' eller 'from_content' anges initierar vi Studio-projektet tomt.

Exempel: [{"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 nullValfri

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.

Tillåtna värden:
titlestring or nullValfri

Ett valfritt namn på författaren till Studio-projektet. Det läggs till som metadata i mp3-filen när Studio-projektet eller kapitlet laddas ned.

authorstring or nullValfri

Ett valfritt namn på författaren till Studio-projektet. Det läggs till som metadata i mp3-filen när Studio-projektet eller kapitlet laddas ned.

descriptionstring or nullValfri

En valfri beskrivning av Studio-projektet.

genreslist of stringsValfri

En valfri lista över genrer som är kopplade till Studio-projektet.

target_audienceenum or nullValfri

En valfri målgrupp för Studio-projektet.

Tillåtna värden:
languagestring or nullValfri=2 characters

Ett valfritt språk för Studio-projektet. Språkkod med två bokstäver (ISO 639-1).

content_typestring or nullValfri

En valfri innehållstyp för Studio-projektet.

original_publication_datestring or nullValfriformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"

Ett valfritt ursprungligt publiceringsdatum för Studio-projektet i formatet YYYY-MM-DD eller YYYY.

mature_contentboolean or nullValfriStandard är false

En valfri uppgift om huruvida Studio-projektet innehåller innehåll för vuxna.

isbn_numberstring or nullValfri

Ett valfritt ISBN-nummer för Studio-projektet du vill skapa. Det läggs till som metadata i mp3-filen när Studio-projektet eller kapitlet laddas ned.

acx_volume_normalizationbooleanValfriStandard är false

[Föråldrat] Om det returnerade ljudet ska efterbehandlas när Studio-projektet laddas ned, så att det uppfyller kraven på normaliserad volym för ljudböcker

volume_normalizationbooleanValfriStandard är false

Om det returnerade ljudet ska efterbehandlas när Studio-projektet laddas ned, så att det uppfyller kraven för normaliserad ljudvolym för ljudböcker

pronunciation_dictionary_locatorslist of stringsValfri

En lista med pekare till uttalslexikon (pronunciation_dictionary_id, version_id), kodade som en lista med JSON-strängar, för uttalslexikon som ska tillämpas på texten. En lista med JSON-kodade strängar krävs eftersom projekt kan läggas till via formData i stället för jsonBody. Om du vill ange flera lexikon använder du flera --form-rader i curl, till exempel --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 nullValfri

En URL som vår tjänst anropar när Studio-projektet har konverterats. Begäran innehåller ett JSON-objekt med konverteringens status. Meddelanden:

  1. När projektet har konverterats: { 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. När projektkonverteringen misslyckades: { type: "project_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567890", project_id: "21m00Tcm4TlvDq8ikWAM", conversion_status: "error", project_snapshot_id: None, error_details: "Error details if conversion failed" } }

  3. När kapitlet har konverterats: { 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. När kapitelkonverteringen misslyckades: { 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: "Error details if conversion failed" } }

fictionenum or nullValfri

En valfri uppgift om huruvida innehållet i Studio-projektet är skönlitteratur.

Tillåtna värden:
apply_text_normalizationenum or nullValfri

Den här parametern styr textnormalisering med fyra lägen: 'auto', 'on', 'apply_english' och 'off'. När den är inställd på 'auto' avgör systemet automatiskt om textnormalisering ska tillämpas (t.ex. att skriva ut tal). Med 'on' tillämpas textnormalisering alltid, medan den hoppas över med 'off'. 'apply_english' är samma som 'on', men förutsätter att texten är på engelska.

Tillåtna värden:
auto_convertbooleanValfriStandard är false

Om Studio-projektet ska konverteras till ljud automatiskt.

auto_assign_voicesboolean or nullValfriStandard är false

[Alfafunktion] Om röster automatiskt ska tilldelas fraser när ett projekt skapas.

source_typeenum or nullValfri

Typen av Studio-projekt som ska skapas.

voice_settingslist of stringsValfri

Valfria åsidosättningar av röstinställningar för projektet, kodade som en lista med JSON-strängar.

Exempel: ["{"voice_id": "21m00Tcm4TlvDq8ikWAM", "stability": 0.7, "similarity_boost": 0.8, "style": 0.5, "speed": 1.0, "use_speaker_boost": true}"]

create_publishing_readboolean or nullValfriStandard är false

Om värdet är true skapas en motsvarande läsning för direktpublicering i utkastläge

Svar

Lyckat svar
projectobject

Fel

422
Unprocessable Entity Error