Skip to navigation

Audio Native-project maken

Maakt een project met Audio Native ingeschakeld, start optioneel de conversie en retourneert de project-ID en een insluitbaar HTML-fragment.

Headers

xi-api-keystringOptional

Request

This endpoint expects a multipart form containing an optional file.
namestringRequired
Projectnaam.
imagestring or nullOptionalDeprecated

(Verouderd) Afbeeldings-URL die in de player wordt gebruikt. Als deze niet is opgegeven, wordt de standaardafbeelding uit de Player-instellingen gebruikt.

authorstring or nullOptional

Auteur die wordt gebruikt in de speler en aan het begin van het geüploade artikel wordt ingevoegd. Als deze niet is opgegeven, wordt de standaardauteur uit de Player-instellingen gebruikt.

titlestring or nullOptional

Titel die in de player wordt gebruikt en bovenaan het geüploade artikel wordt ingevoegd. Indien niet opgegeven, wordt de standaardtitel uit de Player-instellingen gebruikt.

smallbooleanOptionalDefaults to falseDeprecated

(Verouderd) Of de kleine player moet worden gebruikt. Als deze niet is opgegeven, wordt de standaardwaarde uit de Player-instellingen gebruikt.

text_colorstring or nullOptional

Tekstkleur die in de player wordt gebruikt. Als deze niet is opgegeven, wordt de standaardtekstkleur uit de Player-instellingen gebruikt.

background_colorstring or nullOptional

Achtergrondkleur die wordt gebruikt in de speler. Als deze niet is opgegeven, wordt de standaardachtergrondkleur uit de Player-instellingen gebruikt.

sessionizationintegerOptionalDefaults to 0Deprecated

(Verouderd) Geeft aan gedurende hoeveel minuten de sessie behouden blijft bij het opnieuw laden van pagina’s. Als deze niet is opgegeven, wordt de standaard-sessie-instelling uit de Player-instellingen gebruikt.

voice_idstring or nullOptional

Stem-ID die wordt gebruikt om de content in te spreken. Als deze niet wordt opgegeven, wordt de standaardstem-ID uit de Player-instellingen gebruikt.

model_idstring or nullOptional

TTS-model-ID die in de player wordt gebruikt. Indien niet opgegeven, wordt de standaardmodel-ID uit de Player-instellingen gebruikt.

filefileOptional

Een txt- of HTML-invoerbestand met de artikelinhoud. HTML moet als volgt zijn opgemaakt: ‘<html><body><div><p>Je inhoud</p><h3>Meer van je inhoud</h3><p>Nog meer van je inhoud</p></div></body></html>’

auto_convertbooleanOptionalDefaults to false
Of het project automatisch naar audio moet worden geconverteerd.
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:
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”}”’.

Response

Geslaagde response
project_idstring

De ID van het gemaakte Audio Native-project.

convertingboolean
Of het project momenteel wordt geconverteerd.
html_snippetstring

Het HTML-fragment om de Audio Native-player in te sluiten.

Errors

422
Unprocessable Entity Error