Skip to navigation
ElevenCreativeStudio

Studio-project maken

Maakt een nieuw Studio-project, dat leeg, op basis van een document of op basis van een URL kan worden geïnitialiseerd.

Headers

xi-api-keystringOptional

Request

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

De naam van het Studio-project, uitsluitend gebruikt voor identificatie.

default_title_voice_idstring or nullOptional

De voice_id die overeenkomt met de standaardstem die voor nieuwe titels wordt gebruikt.

default_paragraph_voice_idstring or nullOptional

De voice_id die overeenkomt met de standaardstem die voor nieuwe alinea’s wordt gebruikt.

default_model_idstring or nullOptional

De ID van het model dat voor dit Studio-project moet worden gebruikt. Je kunt GET /v1/models opvragen om alle beschikbare modellen weer te geven.

from_urlstring or nullOptional

Een optionele URL waaruit we inhoud extraheren om het Studio-project te initialiseren. Als dit is ingesteld, moeten ‘from_url’ en ‘from_content’ null zijn. Als geen van ‘from_url’, ‘from_document’ en ‘from_content’ is opgegeven, initialiseren we het Studio-project als leeg.

from_documentfileOptional

Je kunt optioneel een .epub-, .pdf-, .txt- of vergelijkbaar bestand opgeven. Als je dat doet, initialiseren we het Studio-project met de inhoud ervan. Als dit is ingesteld, moeten ‘from_url’ en ‘from_content’ null zijn. Als geen van ‘from_url’, ‘from_document’ en ‘from_content’ is opgegeven, initialiseren we het Studio-project als leeg.

from_content_jsonstringOptional

Optionele inhoud om het Studio-project mee te initialiseren. Als dit is ingesteld, moeten ‘from_url’ en ‘from_document’ null zijn. Als ‘from_url’, ‘from_document’ en ‘from_content’ geen van alle zijn opgegeven, initialiseren we het Studio-project als leeg.

Voorbeeld: [{“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 nullOptional

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.

Allowed values:
titlestring or nullOptional

Een optionele naam van de auteur van het Studio-project. Deze wordt als metadata toegevoegd aan het mp3-bestand wanneer je het Studio-project of een hoofdstuk downloadt.

authorstring or nullOptional

Een optionele naam van de auteur van het Studio-project. Deze wordt als metadata toegevoegd aan het mp3-bestand wanneer je het Studio-project of een hoofdstuk downloadt.

descriptionstring or nullOptional

Een optionele beschrijving van het Studio-project.

genreslist of stringsOptional

Een optionele lijst met genres die aan het Studio-project zijn gekoppeld.

target_audienceenum or nullOptional

Een optionele doelgroep van het Studio-project.

Allowed values:
languagestring or nullOptional=2 characters

Een optionele taal van het Studio-project. Taalcode van twee letters (ISO 639-1).

content_typestring or nullOptional

Een optioneel inhoudstype van het Studio-project.

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

Een optionele oorspronkelijke publicatiedatum van het Studio-project, in de indeling YYYY-MM-DD of YYYY.

mature_contentboolean or nullOptionalDefaults to false

Een optionele aanduiding of dit Studio-project content voor volwassenen bevat.

isbn_numberstring or nullOptional

Een optioneel ISBN-nummer van het Studio-project dat je wilt maken. Dit wordt als metadata toegevoegd aan het mp3-bestand wanneer je het Studio-project of een hoofdstuk downloadt.

acx_volume_normalizationbooleanOptionalDefaults to false

[Verouderd] Of de geretourneerde audio bij het downloaden van het Studio-project moet worden nabewerkt om te voldoen aan de vereisten voor genormaliseerd volume van luisterboeken

volume_normalizationbooleanOptionalDefaults to false

Of de geretourneerde audio bij het downloaden van het Studio-project moet worden nabewerkt om te voldoen aan de vereisten voor genormaliseerd volume van luisterboeken

pronunciation_dictionary_locatorslist of stringsOptional

Een lijst met locators voor uitspraakwoordenboeken (pronunciation_dictionary_id, version_id), gecodeerd als een lijst met JSON-strings voor uitspraakwoordenboeken die op de tekst moeten worden toegepast. Een lijst met als JSON gecodeerde strings is vereist, omdat projecten via formData in plaats van jsonBody kunnen worden toegevoegd. Geef meerdere woordenboeken op met meerdere —form-regels in je curl, zoals —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 nullOptional

Een URL die door onze service wordt aangeroepen wanneer het Studio-project wordt geconverteerd. De request bevat een JSON-blob met de status van de conversie. Berichten:

  1. Wanneer het project succesvol is geconverteerd: { 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. Wanneer de projectconversie is mislukt: { type: “project_conversion_status”, event_timestamp: 1234567890, data: { request_id: “1234567890”, project_id: “21m00Tcm4TlvDq8ikWAM”, conversion_status: “error”, project_snapshot_id: None, error_details: “Foutdetails als de conversie is mislukt” } }

  3. Wanneer het hoofdstuk succesvol is geconverteerd: { 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. Wanneer de hoofdstukconversie is mislukt: { 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: “Foutdetails als de conversie is mislukt” } }

fictionenum or nullOptional

Een optionele aanduiding of de inhoud van dit Studio-project fictie is.

Allowed values:
apply_text_normalizationenum or nullOptional

Deze parameter regelt tekstnormalisatie met vier modi: ‘auto’, ‘on’, ‘apply_english’ en ‘off’. Bij de instelling ‘auto’ bepaalt het systeem automatisch of tekstnormalisatie wordt toegepast (bijvoorbeeld het uitschrijven van getallen). Met ‘on’ wordt tekstnormalisatie altijd toegepast, terwijl deze met ‘off’ wordt overgeslagen. ‘apply_english’ is hetzelfde als ‘on’, maar gaat ervan uit dat de tekst Engels is.

Allowed values:
auto_convertbooleanOptionalDefaults to false

Of het Studio-project automatisch naar audio moet worden geconverteerd.

auto_assign_voicesboolean or nullOptionalDefaults to false

[Alpha Feature] Of automatisch stemmen aan zinnen moeten worden toegewezen bij het maken van een project.

source_typeenum or nullOptional

Het type Studio-project dat moet worden gemaakt.

voice_settingslist of stringsOptional

Optionele overschrijvingen van steminstellingen voor het project, gecodeerd als een lijst met JSON-strings.

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

create_publishing_readboolean or nullOptionalDefaults to false
Als true, wordt een bijbehorende read gemaakt voor rechtstreeks publiceren in de conceptstatus

Response

Geslaagde response
projectobject

Errors

422
Unprocessable Entity Error