{"openapi":"3.0.1","info":{"title":"AudioStack","version":"v1","description":"AudioStack - the global backbone of audio production. Infrastructure for AI driven synthetic audio creation. Easily integrate audio into your product or allow end users to create high quality audio. \n","termsOfService":"https://www.aflorithmic.ai/terms-of-use","contact":{"name":"Tech Lead of AudioStack","email":"sam@aflorithmic.ai"}},"servers":[{"url":"https://v2.api.audio","description":"Main production server"}],"paths":{"/speech/voice":{"description":"\n## Product Description\nOut voice service manages voices. You can list and filter ones we have created for you, or in turn you can create your own with our voice cloning product.\nLibrary page: https://library.api.audio/.\n","get":{"tags":["Voice"],"operationId":"listVoices","description":"\n\nTodo\n\n","summary":"List all available voices.","parameters":[{"in":"query","name":"pageLimit","description":"Max. amount of items to be returned per page.\n","schema":{"type":"number","format":"integer"}},{"in":"query","name":"page","description":"Page number to be returned.\n","schema":{"type":"number","format":"integer"}},{"in":"query","name":"sort","description":"Sort order of items by an attribute.\n","schema":{"type":"string"}},{"in":"query","name":"language","description":"Language of the voice.\n","schema":{"type":"string"}},{"in":"query","name":"languageCode","description":"ISO language code of the voice, e.g. en-US\n","schema":{"type":"string"}},{"in":"query","name":"accent","description":"Accent of the voice.","schema":{"type":"string"}},{"in":"query","name":"gender","description":"Gender of the voice.","schema":{"type":"string"}},{"in":"query","name":"ageBracket","description":"Age bracket of the voice.","schema":{"type":"string","enum":["child","adult","senior","young adult"]}},{"in":"query","name":"tags","description":"Tags of the voice. Multiple tags separated by comma are accepted.\n","schema":{"type":"string"}},{"in":"query","name":"industryExamples","description":"Multiple tags separated by comma are accepted.\n","schema":{"type":"string"}},{"in":"query","name":"timePerformance","description":"Relative response time.\n","schema":{"type":"string","enum":["fast","medium","slow"]}},{"in":"query","name":"provider","description":"Provider of the voice.\n","schema":{"type":"string","enum":["msnr","polly","azure","google","ibm","retro","vocalid","resemble","openai","playht","respeecher","narakeet","elevenlabs","speechify","cartesia"]}}],"responses":{"200":{"description":"Voices listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"array","items":{"type":"string"}},"timePerformance":{"type":"string"},"accent":{"type":"string"},"meta":{"type":"object","properties":{"technologies":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"integer"}}},"audioSamples":{"type":"object","properties":{"sr-sr":{"type":"string"},"lv-lv":{"type":"string"},"sv-sv":{"type":"string"},"cy-cy":{"type":"string"},"en-en":{"type":"string"},"no-no":{"type":"string"},"ja-ja":{"type":"string"},"uk-uk":{"type":"string"},"gl-gl":{"type":"string"},"nl-nl":{"type":"string"},"ms-ms":{"type":"string"},"kn-kn":{"type":"string"},"mk-mk":{"type":"string"},"be-be":{"type":"string"},"hu-hu":{"type":"string"},"vi-vi":{"type":"string"},"hi-hi":{"type":"string"},"he-he":{"type":"string"},"ne-ne":{"type":"string"},"pl-pl":{"type":"string"},"ca-ca":{"type":"string"},"pt-pt":{"type":"string"},"ro-ro":{"type":"string"},"tr-tr":{"type":"string"},"hy-hy":{"type":"string"},"fr-fr":{"type":"string"},"fi-fi":{"type":"string"},"az-az":{"type":"string"},"ta-ta":{"type":"string"},"hr-hr":{"type":"string"},"cs-cs":{"type":"string"},"ar-ar":{"type":"string"},"fa-fa":{"type":"string"},"af-af":{"type":"string"},"et-et":{"type":"string"},"zh-zh":{"type":"string"},"lt-lt":{"type":"string"},"sl-sl":{"type":"string"},"el-el":{"type":"string"},"is-is":{"type":"string"},"bs-bs":{"type":"string"},"bg-bg":{"type":"string"},"mi-mi":{"type":"string"},"da-da":{"type":"string"},"de-de":{"type":"string"},"sw-sw":{"type":"string"},"sk-sk":{"type":"string"},"ur-ur":{"type":"string"},"es-es":{"type":"string"},"it-it":{"type":"string"},"ru-ru":{"type":"string"},"id-id":{"type":"string"},"kk-kk":{"type":"string"},"mr-mr":{"type":"string"},"ko-ko":{"type":"string"},"th-th":{"type":"string"}}},"supportedLanguages":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"alias":{"type":"string"},"isMultilingual":{"type":"integer"},"provider":{"type":"string"},"providerFullName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"supportedStyles":{"type":"array"},"defaultStyle":{"type":"array","items":{"type":"string"}},"languageCode":{"type":"string"},"ageBracket":{"type":"string"},"picture":{"type":"string"},"voiceId":{"type":"string"},"gender":{"type":"string"},"providerId":{"type":"string"},"sectionCharacterLimit":{"type":"integer"},"charsPerSecond":{"type":"string"},"basicEmotion":{"type":"string"},"type":{"type":"string"},"audioSample":{"type":"string"}}}},"pageInfo":{"type":"object","properties":{"page":{"type":"integer"},"pageItemsCount":{"type":"integer"},"itemsTotal":{"type":"integer"},"pagesTotal":{"type":"integer"},"pageLimit":{"type":"integer"}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/speech/voice/parameter":{"get":{"tags":["Voice"],"operationId":"listVoiceParameters","summary":"Lists voice parameters.","description":"Lists all the voice parameters used to describe and filter voices","responses":{"200":{"description":"Voice parameters listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"array","items":{"type":"string"}},"timePerformance":{"type":"string"},"accent":{"type":"string"},"meta":{"type":"object","properties":{"technologies":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"integer"}}},"audioSamples":{"type":"object","properties":{"sr-sr":{"type":"string"},"lv-lv":{"type":"string"},"sv-sv":{"type":"string"},"cy-cy":{"type":"string"},"en-en":{"type":"string"},"no-no":{"type":"string"},"ja-ja":{"type":"string"},"uk-uk":{"type":"string"},"gl-gl":{"type":"string"},"nl-nl":{"type":"string"},"ms-ms":{"type":"string"},"kn-kn":{"type":"string"},"mk-mk":{"type":"string"},"be-be":{"type":"string"},"hu-hu":{"type":"string"},"vi-vi":{"type":"string"},"hi-hi":{"type":"string"},"he-he":{"type":"string"},"ne-ne":{"type":"string"},"pl-pl":{"type":"string"},"ca-ca":{"type":"string"},"pt-pt":{"type":"string"},"ro-ro":{"type":"string"},"tr-tr":{"type":"string"},"hy-hy":{"type":"string"},"fr-fr":{"type":"string"},"fi-fi":{"type":"string"},"az-az":{"type":"string"},"ta-ta":{"type":"string"},"hr-hr":{"type":"string"},"cs-cs":{"type":"string"},"ar-ar":{"type":"string"},"fa-fa":{"type":"string"},"af-af":{"type":"string"},"et-et":{"type":"string"},"zh-zh":{"type":"string"},"lt-lt":{"type":"string"},"sl-sl":{"type":"string"},"el-el":{"type":"string"},"is-is":{"type":"string"},"bs-bs":{"type":"string"},"bg-bg":{"type":"string"},"mi-mi":{"type":"string"},"da-da":{"type":"string"},"de-de":{"type":"string"},"sw-sw":{"type":"string"},"sk-sk":{"type":"string"},"ur-ur":{"type":"string"},"es-es":{"type":"string"},"it-it":{"type":"string"},"ru-ru":{"type":"string"},"id-id":{"type":"string"},"kk-kk":{"type":"string"},"mr-mr":{"type":"string"},"ko-ko":{"type":"string"},"th-th":{"type":"string"}}},"supportedLanguages":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"alias":{"type":"string"},"isMultilingual":{"type":"integer"},"provider":{"type":"string"},"providerFullName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"supportedStyles":{"type":"array"},"defaultStyle":{"type":"array","items":{"type":"string"}},"languageCode":{"type":"string"},"ageBracket":{"type":"string"},"picture":{"type":"string"},"voiceId":{"type":"string"},"gender":{"type":"string"},"providerId":{"type":"string"},"sectionCharacterLimit":{"type":"integer"},"charsPerSecond":{"type":"string"},"basicEmotion":{"type":"string"},"type":{"type":"string"},"audioSample":{"type":"string"}}}},"pageInfo":{"type":"object","properties":{"page":{"type":"integer"},"pageItemsCount":{"type":"integer"},"itemsTotal":{"type":"integer"},"pagesTotal":{"type":"integer"},"pageLimit":{"type":"integer"}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/speech/voice/{name}":{"get":{"tags":["Voice"],"operationId":"getVoiceName","summary":"Get data for a single voice.","parameters":[{"in":"path","name":"name","required":true,"description":"Alias or original voice ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Voices retrieved","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"alias":{"type":"string"},"voiceId":{"type":"string"},"languageCode":{"type":"string"},"language":{"type":"string"},"timePerformance":{"type":"string"},"provider":{"type":"string"},"gender":{"type":"string"},"type":{"type":"string"},"email":{"type":"string"},"accent":{"type":"string"},"ageBracket":{"type":"string"},"supportedStyles":{"type":"array"},"defaultStyle":{"type":"array","items":{"type":"string"}},"basicEmotion":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"audioSample":{"type":"string"},"purpose":{"type":"array","items":{"type":"string"}},"picture":{"type":"string"},"charsPerSecond":{"type":"string"},"meta":{"type":"object","properties":{"technologies":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"integer"}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"alias":"joanna","voiceId":"348eb644-b6a1-11ed-ad9b-3a5b2353d1ca","languageCode":"en-US","language":"english","timePerformance":"fast","provider":"polly","gender":"female","type":"public","email":"","accent":"american","ageBracket":"adult","supportedStyles":[],"defaultStyle":["engaging","calm","serious"],"basicEmotion":"neutral","tags":["steady","confident","balanced","informative","serious"],"audioSample":"https://file.audiostack.ai/voice-samples/joanna_english2024-09.mp3","purpose":["advertisement","e-commerce","health and fitness","business"],"picture":"https://file.audiostack.ai/image-samples/linda.jpg","charsPerSecond":"18.26","meta":{"technologies":["TTS"],"createdAt":1624627130}},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Voice retrieved succesfully.","warnings":[]}}}}},"400":{"description":"Voices not found","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Voice hackermansam does not exist. Check available voices at https://library.api.audio/voices"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Voice not found.","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/speech/voice/select":{"post":{"tags":["Voice"],"operationId":"selectVoice","summary":"Get a voice and speed recommendation for your content.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["content","or scriptId"],"properties":{"content":{"type":"string"},"scriptId":{"type":"string"},"tone":{"type":"string"},"gender":{"type":"string","description":"This field is deprecated and will be removed in a future release. Use `filters` instead.","deprecated":true},"targetLength":{"type":"number"},"filters":{"type":"object","properties":{"accent":{"type":"array","items":{"enum":["in","indian","jp","japanese","cn","chinese","ca","canadian","tw","taiwanese","au","australian","rs","serbian","us","american","unknown","nl","dutch","shaanxi","gb","british","guangxi","china","sk","slovak","no","norwegian","xx","lb","lebanese","id","indonesian","vn","vietnamese","ph","filipino","ba","bosnian and herzegovinian","tn","tunisian","de","za","south african","pa","panamanian","it","italian","br","brazilian","ro","romanian","german","es","spanish","ua","ukrainian","pl","polish","ee","estonian","af","afghan","pt","portuguese","multilingual","hk","hong kong","mx","mexican","sichuan","ie","irish","se","swedish","fr","french","uy","uruguayan","al","albanian","ch","swiss","ge","georgian","gt","guatemalan","my","malaysian","pr","puerto rican","ru","russian","tr","turkish","th","thai","bg","bulgarian","dk","danish","kr","south korean","la","laotian","ae","emirati","pk","pakistani","be","belgian","gr","greek","om","omani","shandong","mt","maltese","sv","salvadoran","il","israeli","np","nepalese","mn","mongolian","sg","singaporean","lk","sri lankan","ve","venezuelan","kh","cambodian","hu","hungarian","ke","kenyan","co","colombian","english","ar","argentinian","am","armenian","at","austrian","cl","chilean","ye","yemeni","ng","nigerian","great britain","xa","arabic","hn","honduran","mm","burmese","ec","ecuadorian","ir","iranian","great british","is","icelandic","sa","saudi arabian","liaoning","cz","czech","tz","tanzanian","canada","fi","finnish","france","lv","latvian","none","lt","lithuanian","ma","moroccan","et","ethiopian","mk","macedonian","eg","egyptian","do","dominican","ly","libyan","kw","kuwaiti","so","somali","bh","bahraini","brazil","si","slovenian","cr","costa rican","kz","kazakhstani","uz","uzbekistani","dz","algerian","bo","bolivian","az","azerbaijani","gq","equatorial guinean","ni","nicaraguan","iq","iraqi","nz","new zealand","py","paraguayan","qa","qatari"],"type":"string"},"uniqueItems":true},"gender":{"type":"array","items":{"enum":["male","female","character","unknown"],"type":"string"},"uniqueItems":true},"ageBracket":{"type":"array","items":{"enum":["adult","child","senior","young adult"],"type":"string"},"uniqueItems":true},"provider":{"type":"array","items":{"enum":["google","polly","azure","elevenlabs","ibm","wellsaid","playht","cerevoice","deepzen","retro","resemble","respeecher","narakeet","openai","msnr","speechify","voice_engine_3","voice_engine_2","voice_engine_1","cartesia"],"type":"string"},"uniqueItems":true}},"required":["language"]}}}}}},"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"array","items":{"type":"string"}},"timePerformance":{"type":"string"},"accent":{"type":"string"},"meta":{"type":"object","properties":{"category":{"type":"string"},"technologies":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"integer"}}},"audioSamples":{"type":"object","properties":{"sr-sr":{"type":"string"},"lv-lv":{"type":"string"},"sv-sv":{"type":"string"},"cy-cy":{"type":"string"},"no-no":{"type":"string"},"ja-ja":{"type":"string"},"uk-uk":{"type":"string"},"gl-gl":{"type":"string"},"nl-nl":{"type":"string"},"ms-ms":{"type":"string"},"kn-kn":{"type":"string"},"mk-mk":{"type":"string"},"be-be":{"type":"string"},"hu-hu":{"type":"string"},"vi-vi":{"type":"string"},"hi-hi":{"type":"string"},"he-he":{"type":"string"},"ne-ne":{"type":"string"},"pl-pl":{"type":"string"},"ca-ca":{"type":"string"},"pt-pt":{"type":"string"},"ro-ro":{"type":"string"},"tr-tr":{"type":"string"},"hy-hy":{"type":"string"},"fr-fr":{"type":"string"},"fi-fi":{"type":"string"},"az-az":{"type":"string"},"ta-ta":{"type":"string"},"hr-hr":{"type":"string"},"cs-cs":{"type":"string"},"ar-ar":{"type":"string"},"fa-fa":{"type":"string"},"af-af":{"type":"string"},"et-et":{"type":"string"},"zh-zh":{"type":"string"},"lt-lt":{"type":"string"},"sl-sl":{"type":"string"},"el-el":{"type":"string"},"is-is":{"type":"string"},"bs-bs":{"type":"string"},"bg-bg":{"type":"string"},"mi-mi":{"type":"string"},"da-da":{"type":"string"},"de-de":{"type":"string"},"sw-sw":{"type":"string"},"sk-sk":{"type":"string"},"ur-ur":{"type":"string"},"es-es":{"type":"string"},"it-it":{"type":"string"},"ru-ru":{"type":"string"},"id-id":{"type":"string"},"kk-kk":{"type":"string"},"mr-mr":{"type":"string"},"ko-ko":{"type":"string"},"th-th":{"type":"string"}}},"supportedLanguages":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"alias":{"type":"string"},"isMultilingual":{"type":"integer"},"provider":{"type":"string"},"providerFullName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"supportedStyles":{"type":"array"},"defaultStyle":{"type":"array","items":{"type":"string"}},"languageCode":{"type":"string"},"ageBracket":{"type":"string"},"voiceId":{"type":"string"},"picture":{"type":"string"},"gender":{"type":"string"},"providerId":{"type":"string"},"sectionCharacterLimit":{"type":"integer"},"charsPerSecond":{"type":"string"},"basicEmotion":{"type":"string"},"type":{"type":"string"},"audioSample":{"type":"string"},"speed":{"type":"number"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"voices":[{"purpose":["health and fitness","business","advertisement","audiobook","education","e-commerce"],"timePerformance":"fast","accent":"american","meta":{"category":"generated","technologies":["TTS","STS"],"createdAt":1687699127},"audioSamples":{"sr-sr":"https://file.audiostack.ai/voice-samples/aaron_serbian.mp3","lv-lv":"https://file.audiostack.ai/voice-samples/aaron_latvian.mp3","sv-sv":"https://file.audiostack.ai/voice-samples/aaron_swedish2024-09.mp3","cy-cy":"https://file.audiostack.ai/voice-samples/aaron_welsh.mp3","no-no":"https://file.audiostack.ai/voice-samples/aaron_norwegian.mp3","ja-ja":"https://file.audiostack.ai/voice-samples/aaron_japanese2024-09.mp3","uk-uk":"https://file.audiostack.ai/voice-samples/aaron_ukrainian2024-09.mp3","gl-gl":"https://file.audiostack.ai/voice-samples/aaron_galician.mp3","nl-nl":"https://file.audiostack.ai/voice-samples/aaron_dutch2024-09.mp3","ms-ms":"https://file.audiostack.ai/voice-samples/aaron_malay2024-09.mp3","kn-kn":"https://file.audiostack.ai/voice-samples/aaron_kannada.mp3","mk-mk":"https://file.audiostack.ai/voice-samples/aaron_macedonian.mp3","be-be":"https://file.audiostack.ai/voice-samples/aaron_belarusian.mp3","hu-hu":"https://file.audiostack.ai/voice-samples/aaron_hungarian.mp3","vi-vi":"https://file.audiostack.ai/voice-samples/aaron_vietnamese.mp3","hi-hi":"https://file.audiostack.ai/voice-samples/aaron_hindi2024-09.mp3","he-he":"https://file.audiostack.ai/voice-samples/aaron_hebrew.mp3","ne-ne":"https://file.audiostack.ai/voice-samples/aaron_nepali.mp3","pl-pl":"https://file.audiostack.ai/voice-samples/aaron_polish2024-09.mp3","ca-ca":"https://file.audiostack.ai/voice-samples/aaron_catalan.mp3","pt-pt":"https://file.audiostack.ai/voice-samples/aaron_portuguese2024-09.mp3","ro-ro":"https://file.audiostack.ai/voice-samples/aaron_romanian2024-09.mp3","tr-tr":"https://file.audiostack.ai/voice-samples/aaron_turkish2024-09.mp3","hy-hy":"https://file.audiostack.ai/voice-samples/aaron_armenian.mp3","fr-fr":"https://file.audiostack.ai/voice-samples/aaron_french2024-09.mp3","fi-fi":"https://file.audiostack.ai/voice-samples/aaron_finnish2024-09.mp3","az-az":"https://file.audiostack.ai/voice-samples/aaron_azerbaijani.mp3","ta-ta":"https://file.audiostack.ai/voice-samples/aaron_tamil2024-09.mp3","hr-hr":"https://file.audiostack.ai/voice-samples/aaron_croatian2024-09.mp3","cs-cs":"https://file.audiostack.ai/voice-samples/aaron_czech2024-09.mp3","ar-ar":"https://file.audiostack.ai/voice-samples/aaron_arabic2024-09.mp3","fa-fa":"https://file.audiostack.ai/voice-samples/aaron_persian.mp3","af-af":"https://file.audiostack.ai/voice-samples/aaron_afrikaans.mp3","et-et":"https://file.audiostack.ai/voice-samples/aaron_estonian.mp3","zh-zh":"https://file.audiostack.ai/voice-samples/aaron_chinese2024-09.mp3","lt-lt":"https://file.audiostack.ai/voice-samples/aaron_lithuanian.mp3","sl-sl":"https://file.audiostack.ai/voice-samples/aaron_slovenian.mp3","el-el":"https://file.audiostack.ai/voice-samples/aaron_greek2024-09.mp3","is-is":"https://file.audiostack.ai/voice-samples/aaron_icelandic.mp3","bs-bs":"https://file.audiostack.ai/voice-samples/aaron_bosnian.mp3","bg-bg":"https://file.audiostack.ai/voice-samples/aaron_bulgarian2024-09.mp3","mi-mi":"https://file.audiostack.ai/voice-samples/aaron_maori.mp3","da-da":"https://file.audiostack.ai/voice-samples/aaron_danish2024-09.mp3","de-de":"https://file.audiostack.ai/voice-samples/aaron_german2024-09.mp3","sw-sw":"https://file.audiostack.ai/voice-samples/aaron_swahili.mp3","sk-sk":"https://file.audiostack.ai/voice-samples/aaron_slovak2024-09.mp3","ur-ur":"https://file.audiostack.ai/voice-samples/aaron_urdu.mp3","es-es":"https://file.audiostack.ai/voice-samples/aaron_spanish2024-09.mp3","it-it":"https://file.audiostack.ai/voice-samples/aaron_italian2024-09.mp3","ru-ru":"https://file.audiostack.ai/voice-samples/aaron_russian.mp3","id-id":"https://file.audiostack.ai/voice-samples/aaron_indonesian2024-09.mp3","kk-kk":"https://file.audiostack.ai/voice-samples/aaron_kazakh.mp3","mr-mr":"https://file.audiostack.ai/voice-samples/aaron_marathi.mp3","ko-ko":"https://file.audiostack.ai/voice-samples/aaron_korean2024-09.mp3","th-th":"https://file.audiostack.ai/voice-samples/aaron_thai.mp3"},"supportedLanguages":["belarusian","croatian","kannada","norwegian","bulgarian","korean","japanese","maori","welsh","marathi","catalan","hebrew","slovenian","czech","romanian","estonian","hindi","macedonian","serbian","icelandic","english","chinese","tagalog","kazakh","russian","lithuanian","bosnian","portuguese","indonesian","azerbaijani","spanish","hungarian","german","swahili","arabic","polish","malay","urdu","thai","swedish","latvian","slovak","ukrainian","afrikaans","armenian","french","galician","persian","finnish","italian","danish","turkish","tamil","nepali","vietnamese","dutch","greek","multilingual"],"language":"multilingual","alias":"aaron","isMultilingual":true,"provider":"elevenlabs","providerFullName":"elevenlabs","tags":["upbeat","confident","informative","energetic"],"supportedStyles":[],"defaultStyle":["engaging","calm","joyful","serious"],"languageCode":"en-US","ageBracket":"adult","voiceId":"30c564db-3c46-4500-aa48-edbe0baf4768","picture":"https://file.audiostack.ai/image-samples/30c564db-3c46-4500-aa48-edbe0baf4768.jpg","gender":"male","providerId":"cqWnBsJGo0W19eIjBvTU","sectionCharacterLimit":10000,"charsPerSecond":"17.34","basicEmotion":"happy","type":"public","audioSample":"https://file.audiostack.ai/voice-samples/aaron_multilingual2024-09-17.mp3","speed":0.9},{"purpose":["health and fitness","kids tech","advertisement","audiobook","customer service"],"timePerformance":"fast","accent":"american","meta":{"category":"generated","technologies":["TTS","STS"],"createdAt":1687699127},"audioSamples":{"sr-sr":"https://file.audiostack.ai/voice-samples/myriam_serbian.mp3","lv-lv":"https://file.audiostack.ai/voice-samples/myriam_latvian.mp3","sv-sv":"https://file.audiostack.ai/voice-samples/myriam_swedish2024-09.mp3","cy-cy":"https://file.audiostack.ai/voice-samples/myriam_welsh.mp3","no-no":"https://file.audiostack.ai/voice-samples/myriam_norwegian.mp3","ja-ja":"https://file.audiostack.ai/voice-samples/myriam_japanese2024-09.mp3","uk-uk":"https://file.audiostack.ai/voice-samples/myriam_ukrainian2024-09.mp3","gl-gl":"https://file.audiostack.ai/voice-samples/myriam_galician.mp3","nl-nl":"https://file.audiostack.ai/voice-samples/myriam_dutch2024-09.mp3","ms-ms":"https://file.audiostack.ai/voice-samples/myriam_malay2024-09.mp3","kn-kn":"https://file.audiostack.ai/voice-samples/myriam_kannada.mp3","mk-mk":"https://file.audiostack.ai/voice-samples/myriam_macedonian.mp3","be-be":"https://file.audiostack.ai/voice-samples/myriam_belarusian.mp3","hu-hu":"https://file.audiostack.ai/voice-samples/myriam_hungarian.mp3","vi-vi":"https://file.audiostack.ai/voice-samples/myriam_vietnamese.mp3","hi-hi":"https://file.audiostack.ai/voice-samples/myriam_hindi2024-09.mp3","he-he":"https://file.audiostack.ai/voice-samples/myriam_hebrew.mp3","ne-ne":"https://file.audiostack.ai/voice-samples/myriam_nepali.mp3","pl-pl":"https://file.audiostack.ai/voice-samples/myriam_polish2024-09.mp3","ca-ca":"https://file.audiostack.ai/voice-samples/myriam_catalan.mp3","pt-pt":"https://file.audiostack.ai/voice-samples/myriam_portuguese2024-09.mp3","ro-ro":"https://file.audiostack.ai/voice-samples/myriam_romanian2024-09.mp3","tr-tr":"https://file.audiostack.ai/voice-samples/myriam_turkish2024-09.mp3","hy-hy":"https://file.audiostack.ai/voice-samples/myriam_armenian.mp3","fr-fr":"https://file.audiostack.ai/voice-samples/myriam_french2024-09.mp3","fi-fi":"https://file.audiostack.ai/voice-samples/myriam_finnish2024-09.mp3","az-az":"https://file.audiostack.ai/voice-samples/myriam_azerbaijani.mp3","ta-ta":"https://file.audiostack.ai/voice-samples/myriam_tamil2024-09.mp3","hr-hr":"https://file.audiostack.ai/voice-samples/myriam_croatian2024-09.mp3","cs-cs":"https://file.audiostack.ai/voice-samples/myriam_czech2024-09.mp3","ar-ar":"https://file.audiostack.ai/voice-samples/myriam_arabic2024-09.mp3","fa-fa":"https://file.audiostack.ai/voice-samples/myriam_persian.mp3","af-af":"https://file.audiostack.ai/voice-samples/myriam_afrikaans.mp3","et-et":"https://file.audiostack.ai/voice-samples/myriam_estonian.mp3","zh-zh":"https://file.audiostack.ai/voice-samples/myriam_chinese2024-09.mp3","lt-lt":"https://file.audiostack.ai/voice-samples/myriam_lithuanian.mp3","sl-sl":"https://file.audiostack.ai/voice-samples/myriam_slovenian.mp3","el-el":"https://file.audiostack.ai/voice-samples/myriam_greek2024-09.mp3","is-is":"https://file.audiostack.ai/voice-samples/myriam_icelandic.mp3","bs-bs":"https://file.audiostack.ai/voice-samples/myriam_bosnian.mp3","bg-bg":"https://file.audiostack.ai/voice-samples/myriam_bulgarian2024-09.mp3","mi-mi":"https://file.audiostack.ai/voice-samples/myriam_maori.mp3","da-da":"https://file.audiostack.ai/voice-samples/myriam_danish2024-09.mp3","de-de":"https://file.audiostack.ai/voice-samples/myriam_german2024-09.mp3","sw-sw":"https://file.audiostack.ai/voice-samples/myriam_swahili.mp3","sk-sk":"https://file.audiostack.ai/voice-samples/myriam_slovak2024-09.mp3","ur-ur":"https://file.audiostack.ai/voice-samples/myriam_urdu.mp3","es-es":"https://file.audiostack.ai/voice-samples/myriam_spanish2024-09.mp3","it-it":"https://file.audiostack.ai/voice-samples/myriam_italian2024-09.mp3","ru-ru":"https://file.audiostack.ai/voice-samples/myriam_russian.mp3","id-id":"https://file.audiostack.ai/voice-samples/myriam_indonesian2024-09.mp3","kk-kk":"https://file.audiostack.ai/voice-samples/myriam_kazakh.mp3","mr-mr":"https://file.audiostack.ai/voice-samples/myriam_marathi.mp3","ko-ko":"https://file.audiostack.ai/voice-samples/myriam_korean2024-09.mp3","th-th":"https://file.audiostack.ai/voice-samples/myriam_thai.mp3"},"supportedLanguages":["thai","german","belarusian","icelandic","estonian","bosnian","macedonian","swahili","nepali","serbian","english","lithuanian","swedish","croatian","dutch","indonesian","finnish","azerbaijani","danish","romanian","latvian","malay","portuguese","russian","persian","hindi","hebrew","korean","greek","kannada","marathi","polish","czech","spanish","tagalog","afrikaans","hungarian","chinese","kazakh","norwegian","urdu","slovenian","armenian","catalan","italian","welsh","slovak","french","tamil","japanese","maori","arabic","turkish","ukrainian","galician","vietnamese","bulgarian","multilingual"],"language":"multilingual","alias":"myriam","isMultilingual":true,"provider":"elevenlabs","providerFullName":"elevenlabs","tags":["fun","upbeat","confident","energetic"],"supportedStyles":[],"defaultStyle":["engaging","calm","joyful","serious"],"languageCode":"en-US","ageBracket":"adult","voiceId":"2b51a82d-1ee2-4ae3-910a-35200aebb7ef","picture":"https://file.audiostack.ai/image-samples/2b51a82d-1ee2-4ae3-910a-35200aebb7ef.jpg","gender":"female","providerId":"6DMmFmA8yQC9XHTx2iRj","sectionCharacterLimit":10000,"charsPerSecond":"20.16","basicEmotion":"happy","type":"public","audioSample":"https://file.audiostack.ai/voice-samples/myriam_multilingual2024-09-17.mp3","speed":0.9},{"purpose":["health and fitness","business","audiobook","customer service","IVR"],"timePerformance":"medium","accent":"american","meta":{"technologies":["TTS"],"createdAt":1624627133},"supportedLanguages":["english"],"language":"english","alias":"narration_gia","isMultilingual":false,"provider":"wellsaid","providerFullName":"wellsaid labs","tags":["upbeat","formal","slow","informative","storytelling","energetic","low pitched"],"supportedStyles":[],"defaultStyle":["engaging","joyful"],"languageCode":"en-US","ageBracket":"adult","picture":"https://file.audiostack.ai/image-samples/narration_gia.jpg","voiceId":"348ec116-b6a1-11ed-ad9b-3a5b2353d1ca","gender":"female","providerId":"49","sectionCharacterLimit":1000,"charsPerSecond":"17.64","basicEmotion":"happy","audioSample":"https://file.audiostack.ai/voice-samples/narration_gia_english2024-09.mp3","type":"public","speed":0.9},{"purpose":["advertisement","e-commerce","health and fitness","business"],"timePerformance":"medium","accent":"american","meta":{"technologies":["TTS"],"createdAt":1624627133},"supportedLanguages":["english"],"language":"english","alias":"promo_joe","isMultilingual":false,"provider":"wellsaid","providerFullName":"wellsaid labs","tags":["fun","upbeat","confident","fast","informative","storytelling","energetic","steady","balanced","deep","low pitched","raspy"],"supportedStyles":[],"defaultStyle":["engaging","calm"],"languageCode":"en-US","ageBracket":"adult","picture":"https://file.audiostack.ai/image-samples/promo_joe.jpg","voiceId":"348eb9fa-b6a1-11ed-ad9b-3a5b2353d1ca","gender":"male","providerId":"28","sectionCharacterLimit":1000,"charsPerSecond":"17.42","basicEmotion":"neutral","audioSample":"https://file.audiostack.ai/voice-samples/promo_joe_english2024-09.mp3","type":"public","speed":0.9},{"purpose":["advertisement","e-commerce","health and fitness","business"],"timePerformance":"medium","accent":"american","meta":{"technologies":["TTS"],"createdAt":1624627133},"supportedLanguages":["english"],"language":"english","alias":"narration_kai","isMultilingual":false,"provider":"wellsaid","providerFullName":"wellsaid labs","tags":["fun","upbeat","confident","fast","informative","storytelling","energetic","steady","balanced","high pitched"],"supportedStyles":[],"defaultStyle":["engaging","joyful"],"languageCode":"en-US","ageBracket":"adult","picture":"https://file.audiostack.ai/image-samples/narration_kai.jpg","voiceId":"348ebb44-b6a1-11ed-ad9b-3a5b2353d1ca","gender":"male","providerId":"32","sectionCharacterLimit":1000,"charsPerSecond":"17.78","basicEmotion":"happy","audioSample":"https://file.audiostack.ai/voice-samples/narration_kai_english2024-09.mp3","type":"public","speed":0.9}]},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"voices recommended","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"scriptId not found","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["scriptId not found"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find scriptId","warnings":[]}}}}},"422":{"description":"Invalid tone","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Invalid tone. Available Tones are: informative, tense, calm, fast, upbeat, serious, flat, confident, energetic, low pitched, storytelling, slow, raspy, high pitched, thin, steady, formal, deep, balanced, whispering, fun, sad"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"failed to select voices","warnings":[]}}}}}}}},"/speech/diction/custom/item":{"description":"\n## Product Description\nOur dictionary service is...\n\n","put":{"tags":["Dictionary"],"operationId":"putWordInDictionary","summary":"Add word to a custom dictionary","description":"\n\nFor each language, only a single word entry is permitted. However, each word can have multiple specializations. When a word is first registered a default specialization is always created, which will match what is passed in. Subsequent calls with different specializations will only update the given specialization. The exact repacement that will be used is determined by the following order of preference:\n\nvoice name > language dialect > provider name > default\n\nFor example, a replacement specified for voice name sara will be picked over a replacement specified for provider azure.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"lang":{"type":"string","description":"Language family, e.g. en or es.dictionary - use global to register a word globally (default).","default":"global"},"word":{"type":"string","description":"Word to be replaced."},"replacement":{"type":"string","description":"The replacement token. Can be either a plain string or a IPA token."},"contentType":{"type":"string","description":"The content type of the supplied replacement, can be either basic (default) or ipa for phonetic replacements."},"specialization":{"type":"string","description":"by default the supplied replacement will apply regardless of the supplied voice, language code or provider. However edge cases can be supplied, these can be either a valid; provider name, language code (i.e. en-gb) or voice name."}},"required":["word","replacement"]}}}},"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"replacements":{"type":"object","properties":{"default":{"type":"object","properties":{"type":{"type":"string"},"replacement":{"type":"string"}}}}},"inputs":{"type":"array","items":{"type":"string"}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"replacements":{"default":{"type":"basic","replacement":"saypeeoons"}},"inputs":["sapiens"]},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Occurrences of 'sapiens' will now be replaced for 'saypeeoons' in 'global' language dictionary","warnings":[]}}}}},"400":{"description":"Word not added, see errors","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Empty body"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to add word to dictionary","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}},"delete":{"tags":["Dictionary"],"operationId":"deleteWordInDictionary","summary":"Deletes a word from a dictionary.","description":"By default this will delete all specializations of the word, if you want to delete a specific specialization, supply this as a query parameter","parameters":[{"in":"query","name":"lang","required":true,"schema":{"type":"string"}},{"in":"query","name":"word","required":true,"schema":{"type":"string"}},{"in":"query","name":"specialization","required":false,"description":"Delete a specific specialization","schema":{"type":"string"}}],"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"word 'xyz' removed","warnings":[]}}}}},"400":{"description":"Word not deleted, see errors","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["word and lang must be provided"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to delete word from dictionary","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/speech/diction":{"get":{"tags":["Dictionary"],"operationId":"listDictionaries","summary":"List dictionaries","description":"Lists all  public dictionaries. This lists all the words but not the actual replacements. Listing of replacement tokens for inbuilt dicts is not available","responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"dictionaries":{"type":"array","items":{"type":"object","properties":{"lang":{"type":"string"},"words":{"type":"array","items":{"type":"string"}},"content":{"type":"string"},"wordCategory":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/speech/diction/custom":{"get":{"tags":["Dictionary"],"operationId":"listCustomDictionaries","summary":"List dictionaries","description":"Lists all custom dictionaries. This lists all the words but not the actual replacements.","responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"dictionaries":{"type":"array","items":{"type":"object","properties":{"lang":{"type":"string"},"words":{"type":"array","items":{"type":"string"}},"content":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/speech/diction/custom/items":{"get":{"tags":["Dictionary"],"operationId":"listCustomWords","summary":"Lists all words within a custom dictionary. Lang must be supplied.","parameters":[{"in":"query","name":"lang","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"words":{"type":"array","items":{"type":"object","properties":{"replacements":{"type":"object","properties":{"default":{"type":"object","properties":{"type":{"type":"string"},"replacement":{"type":"string"}}}}},"inputs":{"type":"array","items":{"type":"string"}}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"400":{"description":"Failed to list words","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["lang must be provided"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to list words","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/production/sound/template":{"description":"\n## Product Description\n\nOur sound service manages sound templates. You can list and filter ones we have created for you, or you can create your own with your own uploaded sounds.\n","post":{"tags":["Sound Template"],"operationId":"postTemplate","summary":"Create a sound template resource.","description":"\nIn order to integrate a custom audio file into a project, you need to upload it as a file and then create a sound template.\n\nA sound template contains two distinct components, metadata and segments.\n\nMetadata, simply put, is metadata detailing the style, genre, tags and description of the sound template.\n\nSegments are the audio file components of a sound template object. A template can contain many sound segments, in our own library they usually have three: intro, main, and outro. These names are only used as symbolic placeholders - you might wish to name yours differently. You can find step-by-step instructions for creating custom sound templates in the Guide section.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"templateName":{"type":"string","description":"Name of the template"},"description":{"type":"string","description":"Description of the template"},"isElastic":{"type":"boolean","default":false,"description":"Elastic templates are currently not available to self-serve customers"}},"required":["templateName"]}}}},"responses":{"200":{"description":"Sound template created","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"template":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"samples":{"type":"object","properties":{}},"layers":{"type":"object","properties":{}},"tags":{"type":"object","properties":{}},"durations":{"type":"object","properties":{}},"license_type":{"type":"string"},"segmentNames":{"type":"array"},"accessType":{"type":"string"},"soundTemplateId":{"type":"string"},"templateGeneration":{"type":"object","properties":{}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"template":{"name":"test104","alias":"test104","samples":{},"layers":{},"tags":{},"durations":{},"license_type":"standard","segmentNames":[],"accessType":"private","soundTemplateId":"62e077d2-36d7-44b9-aa59-7e43022bf0aa","templateGeneration":{}}},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"New template created","warnings":[]}}}}},"403":{"description":"Could not find a valid api key and/or your org cannot created templates","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Sound template not created","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Request failed with error the JSON object must be str, bytes or bytearray, not NoneType"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Empty body in event","warnings":[]}}}}}}},"get":{"tags":["Sound Template"],"operationId":"getTemplate","summary":"Lists available sound templates.","description":"\n\nLists all of the available sound templates that can be used in your audio project.\n\n","parameters":[{"in":"query","name":"pageLimit","description":"Max. amount of items to be returned per page.\n","schema":{"type":"number","format":"integer"}},{"in":"query","name":"page","description":"Page number to be returned.\n","schema":{"type":"number","format":"integer"}},{"in":"query","name":"moods","schema":{"type":"string"}},{"in":"query","name":"collections","schema":{"type":"string"}},{"in":"query","name":"instruments","schema":{"type":"string"}},{"in":"query","name":"genres","schema":{"type":"string"}}],"responses":{"200":{"description":"Sound templates listed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["tags is not an allowed filtering parameter. Allowed filtering parameters: license_type moods mood_clusters collections collection_clusters instruments genres template_generation"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to list sound templates","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"405":{"description":"Sound templates not listed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["soundLevel is not an allowed filtering parameter. Allowed filtering parameters: license_type moods mood_clusters collections collection_clusters instruments genres template_generation"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to list sound templates","warnings":[]}}}}}}}},"/production/sound/template/{name}":{"delete":{"tags":["Sound Template"],"operationId":"deleteTemplate","summary":"Deletes a sound template","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sound template deleted","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Template 96888472-c92e-453d-a439-2d4cbadfad9a has been deleted.","warnings":[]}}}}},"403":{"description":"Could not find a valid api key and/or your org cannot created templates","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Sound template not deleted","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Unable to delete template, it does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to delete template","warnings":[]}}}}}}}},"/production/sound/parameter":{"get":{"tags":["Sound Template"],"operationId":"getTemplateParameters","summary":"Lists sound templates parameters.","description":"\n\nLists all the parameters used to describe and filter sound templates\n\n","responses":{"200":{"description":"Sound template parameters listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"parameters":{"type":"object","properties":{"license_type":{"type":"array","items":{"type":"string"}},"moods":{"type":"array","items":{"type":"string"}},"mood_clusters":{"type":"object","properties":{"calm":{"type":"array","items":{"type":"string"}},"mellow":{"type":"array","items":{"type":"string"}},"exciting":{"type":"array","items":{"type":"string"}},"happy":{"type":"array","items":{"type":"string"}},"sad":{"type":"array","items":{"type":"string"}},"dark":{"type":"array","items":{"type":"string"}},"neutral":{"type":"array","items":{"type":"string"}},"dreamy":{"type":"array","items":{"type":"string"}},"tense":{"type":"array","items":{"type":"string"}}}},"collections":{"type":"array","items":{"type":"string"}},"collection_clusters":{"type":"object","properties":{"commercial":{"type":"array","items":{"type":"string"}},"informative":{"type":"array","items":{"type":"string"}},"cinematic":{"type":"array","items":{"type":"string"}},"ambiental":{"type":"array","items":{"type":"string"}},"sports":{"type":"array","items":{"type":"string"}},"entertainment":{"type":"array","items":{"type":"string"}}}},"instruments":{"type":"array","items":{"type":"string"}},"genres":{"type":"array","items":{"type":"string"}},"template_generation":{"type":"array","items":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"parameters":{"license_type":["demo","standard"],"moods":["upbeat","dreamy","angry","calm","happy","sad","wavering","exciting","melancholic","disturbing","weird","peaceful","contemplative","quiescent","reflective","tense","nostalgic","friendly","slow","soft","intimate","chill","passionate","energetic","intense","alarming","gloomy","languid","annoying","dark","suspense","catchy","aggresive","gentle","quiet","loud","sexy","fresh","sweet","cool","emotional","fast","mellow","droopy","hesitant","dejecting","depressing","aprehensive","disconcerted","uncomfortable","despondent","dissatisfying","miserable","dissapointing","starting","insulting","annoying","enraging","loathing","adventurous","triumphant","delighting","joyous","enthusiastic","pleasing","meditative","positive","hopeful","funny","uplifting"],"mood_clusters":{"calm":["upbeat","dreamy","calm","peaceful","contemplative","reflective","nostalgic","friendly","slow","soft","intimate","chill","gentle","quiet","emotional","mellow","pleasing","meditative","positive","hopeful"],"mellow":["upbeat","happy","friendly","soft","intimate","chill","passionate","catchy","gentle","quiet","fresh","sweet","mellow","delighting","joyous","enthusiastic","pleasing","positive","hopeful","funny","uplifting"],"exciting":["angry","exciting","tense","energetic","intense","alarming","aggresive","loud","sexy","cool","fast","annoying","enraging","adventurous","triumphant"],"happy":["happy","exciting","passionate","energetic","intense","catchy","sexy","fresh","sweet","cool","fast","adventurous","triumphant","delighting","joyous","enthusiastic","positive","funny","uplifting"],"sad":["sad","wavering","melancholic","quiescent","slow","gloomy","languid","emotional","droopy","hesitant","dejecting","depressing","aprehensive","disconcerted","uncomfortable","despondent","dissatisfying","miserable","dissapointing"],"dark":["sad","disturbing","weird","quiescent","gloomy","annoying","dark","suspense","loud","depressing","disconcerted","uncomfortable","despondent","dissatisfying","miserable","dissapointing","starting","insulting","loathing"],"neutral":["neutral"],"dreamy":["dreamy","calm","wavering","melancholic","peaceful","contemplative","reflective","nostalgic","slow","languid","quiet","emotional","droopy","hesitant","dejecting","aprehensive","meditative"],"tense":["angry","disturbing","weird","tense","alarming","annoying","dark","suspense","aggresive","loud","fast","starting","insulting","annoying","enraging","loathing"]},"collections":["action/adventure","drama","epic","romantic","atmospheric","soundscape","nature","party","cartoonish","slow dance","fitness","newscast","podcast","educational","advertising"],"collection_clusters":{"commercial":["advertising"],"informative":["newscast","podcast","educational"],"cinematic":["action/adventure","drama","epic","romantic"],"ambiental":["atmospheric","soundscape","nature"],"sports":["fitness"],"entertainment":["party","cartoonish","slow dance"]},"instruments":["guitar","bass","strings","drums","piano","synth","harpsichord","woodwinds","choir","voice"],"genres":["classical","electronic","rock","traditional","voice","pop","country","ambient","indie","jazz","acoustic","hip-hop","choral"],"template_generation":["static","elastic","fixed_length"]}},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested sound template parameters listed below","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/production/sound/atmospheres":{"description":"\n## Product Description\n\nOur sound service manages sound templates. You can list and filter ones we have created for you, or you can create your own with your own uploaded sounds.\n"},"/production/sound/segment":{"description":"\n\n# how sound segments work\n\n","post":{"tags":["Sound Segment"],"operationId":"postSegment","summary":"Adds a sound segment to an existing sound template","description":"\n\nHow to transfer sound segments from media\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"templateName":{"type":"string","description":"Name of the template"},"segmentName":{"type":"string","description":"Name of the segment"},"mediaId":{"type":"string","description":"Id of the media file to transfer into a sound segment"}},"required":["templateName","segmentName","mediaId"]}}}},"responses":{"200":{"description":"Sound segment created","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"template":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"samples":{"type":"object","properties":{}},"layers":{"type":"object","properties":{}},"tags":{"type":"object","properties":{}},"durations":{"type":"object","properties":{}},"license_type":{"type":"string"},"segmentNames":{"type":"array"},"accessType":{"type":"string"},"soundTemplateId":{"type":"string"},"templateGeneration":{"type":"object","properties":{}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"template":{"name":"test102","alias":"test102","samples":{},"layers":{},"tags":{},"durations":{},"license_type":"standard","segmentNames":[],"accessType":"private","soundTemplateId":"95d62826-5ad7-463c-ba89-1b1f30866d1c","templateGeneration":{}}},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"New template created","warnings":[]}}}}},"403":{"description":"Could not find a valid api key and/or your org cannot created templates","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Sound segment not created","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["the JSON object must be str, bytes or bytearray, not NoneType"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create a new sound segment","warnings":[]}}}}}}}},"/production/sound/select":{"description":"\n## Product Description\n\nOur sound service manages sound templates. You can list and filter ones we have created for you, or you can create your own with your own uploaded sounds.\n","post":{"tags":["Sound Template"],"operationId":"postSelectTemplate","summary":"Get a Sound Template recommendation for your content.","description":"\n\nRecommends a sound template for your audio project based on given script content and a provided mood.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["content","or scriptId"],"properties":{"content":{"type":"string"},"scriptId":{"type":"string"},"mood":{"type":"string"}}}}}},"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"samples":{"type":"object","properties":{"default":{"type":"string"}}},"layers":{"type":"object","properties":{}},"tags":{"type":"object","properties":{"moods":{"type":"array","items":{"type":"string"}},"tempo":{"type":"array","items":{"type":"integer"}},"instruments":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"string"}},"genres":{"type":"array","items":{"type":"string"}}}},"durations":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"increments":{"type":"integer"},"fixedValues":{"type":"array","items":{"type":"integer"}}}},"license_type":{"type":"string"},"segmentNames":{"type":"array","items":{"type":"string"}},"accessType":{"type":"string"},"soundTemplateId":{"type":"string"},"templateGeneration":{"type":"object","properties":{"data":{"type":"object","properties":{}},"type":{"type":"string"}}}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"templates":[{"name":"Dream Of The 90s","alias":"dream_of_the_90s","samples":{"default":"https://file.api.audio/template-samples-prod/dream_of_the_90s.mp3"},"layers":{},"tags":{"moods":["happy","sweet","catchy","enthusiastic","cool","passionate","mellow"],"tempo":[117],"instruments":["guitar"],"collections":["commercial","advertising"],"genres":["electronic"]},"durations":{"min":16,"max":16,"increments":0,"fixedValues":[16]},"license_type":"standard","segmentNames":["intro"],"accessType":"public","soundTemplateId":"a98ff0b8-0c45-4879-b82c-f52707527dac","templateGeneration":{"data":{},"type":"static"}},{"name":"The Journey Enthusiastic","alias":"the_journey_enthusiastic","samples":{"default":"https://file.api.audio/template-samples-prod/the_journey_enthusiastic.mp3"},"layers":{},"tags":{"moods":["sad","quiescent","disconcerted","dark"],"tempo":[144],"instruments":["drums"],"collections":["informative","newscast"],"genres":["electronic"]},"durations":{"min":169,"max":169,"increments":0,"fixedValues":[169]},"license_type":"standard","segmentNames":["main"],"accessType":"public","soundTemplateId":"d33b2971-5067-4f81-9007-776d440b65c4","templateGeneration":{"data":{},"type":"static"}},{"name":"Clover Dreams","alias":"clover_dreams","samples":{"default":"https://file.api.audio/template-samples-prod/clover_dreams.mp3"},"layers":{},"tags":{"moods":["happy","sweet","passionate","catchy","enthusiastic","mellow"],"tempo":[112],"instruments":["woodwinds"],"collections":["ambiental","soundscape"],"genres":["classical"]},"durations":{"min":155.6,"max":155.6,"increments":0,"fixedValues":[155.6]},"license_type":"standard","segmentNames":["main"],"accessType":"public","soundTemplateId":"a006f9ad-0ad6-44d7-b8cf-db186883870e","templateGeneration":{"data":{},"type":"static"}}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"sound templates recommended","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"422":{"description":"Invalid Json or required keys not present","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Required keys not present in RequestBody!"],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"provide scriptId or content!","warnings":[]}}}}}}}},"/speech/predict":{"description":"Predicts the resultant length of a given voice alias","post":{"tags":["Predict"],"operationId":"postPredict","summary":"Predicts the resultant audio length of the given text content read by the supplied voice alias","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"voice":{"type":"string","description":"Name of the voice"},"text":{"type":"string","description":"Text that will be read"}},"required":["voice","text"]}}}},"responses":{"200":{"description":"voice predicted","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"length":{"type":"number"},"r2":{"type":"number"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"length":3.118831041074268,"r2":0.9730056021652634},"meta":{"version":"1.0.1","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"prediction calculated","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Unable to predict with this voice","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Unable to find a profile for the selected alias"],"meta":{"version":"1.0.1","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"prediction cannot be calculated","warnings":[]}}}}}}}},"/speech/predict/voices":{"get":{"tags":["Predict"],"operationId":"listPredictVoices","summary":"Lists all voices that can be predict resultant audio length","responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"string"}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"voices":["hailey","conversational_marcus","narration_kai","carmen","andres","kiara","promo_joe","rodrigo","yves","carlos","alden","hannah","nanami","prabhat","sardor","abeo","elena","conversational_wade","raymond","ardi","fatima","tomas","joanna","mario","birgit","frederic","ahmet","shelly","cosmo","muriel","lyra","marlon","reynold","margot","narration_donna","joaquin","allison","ismael","renata","olivia","asilia","renee","grey","elizabeth","fergus","narration_cameron","moaz","leia","petra","adam","conrad","hamed","alain","conversational_greg","ahmed","promo_charlie","promo_bella","rafiki","adele","santiago","emily","jacqueline","swara","yolanda","henry","aiden","selma","dimas","beth","anneli","terron","cora","sonia","polina","killian","sofia","hedi","osman","verena","ronny","elke","jorge","bashkar","promo_zach","ryan","rana","thay","monica","hiugaai","athina","bruce","ruben","almir","alba","emi","promo_selene","cynthia","chava","marisa","mohan","wu","gabriel","dalia","narration_greg","promo_ramona","elliot","juan-martin","promo_steve","isabela","catia","claude","belkys","emil","alvaro","domenic","graham","daulet","marta","juan-gabriel","ciarra","quincy","xiaobei","imelda","promo_eric","svetlana","laith","luna","brandon","hamdan","jonas","narration_tobin","anthony","pippa","ji-min","elsa","tamas","kasper","vicki","camila","caitlin","klaus","asad","everita","priyanka","dena","cataldo","jona","clara","jeff","lupe","vicky","andy","sylvie","anu","prashant","liberto","mirna","yvette","aaron","katja","eusebio","maja","calimero","mariana","emel","narration_paige","ariane","narration_chase","paloma","ivey","gonzalo","narration_sofia","narration_jeremy","kelso","fiamma","uzma","nikolina","susanna","georgia","ashley","bella","catalina","gul","denise","martyna","paulo","ava","sara","gianni","luis","tina","jerome","toni","emilio","verona","narration_terra","james","nicolas","narration_vanessa","nestoras","bertie","bong-jin","bryer","conversational_patrick","edgard","valeria","ali","amina","besnik","promo_lee","conversational_alan","molly","leonas","marek","lena","dan","albert","antonin","roberto","antonio","yan","viktoria","jessica","zach","wayne","promo_paul","narration_ali","victor","mateo","coco","colette","charlie","maisie","diego","leah","moses","narration_ben","dmitry","narration_gia","avri","sobhana","matthias","fernanda","jamal","ahme","neerja","alina","kiel","victoria","gabriela","jose-pascual","charline","kate","luiz","lisa","taim","nikola","amanda","brenda","anxhela","adriana","ramona","mattias","arnaud","narration_diarmid","alex","midhun","fady","tanja","christel","noemi","candice","maarten","charlotte","shakir","ayanda","savannah","libby","yasmin","gabrijela","zara","stefan","reem","vitoria","nathan","elshan","louisa","celeste","nils","finn","conversational_antony","alfie","gisela","ingrid","conversational_alana","luke","christopher","narration_wade","penelope","vlasta","connor","suman","gene","sasha","guy","ethan","raquel","hsiaochen","josh","tanishaa","miguel","saleh","adri","marine","joel","kert","promo_greg","bernd","inessa","dolores","harper","aparecida","anya","hoaimy","francesca","ana","elijah","lidia","promo_jodi","heber","belen","ubax","lorenzo","achara","ralf","aigu","mhairi","hudson","bikram","donald","promo_wade","salome","dylan","narration_fiona","dieter","maura","benigno","lisandro","daichi","namminh","tony","xiaochen","willem","narration_joe","salma","latifa","coralie","palmira","hiumaan","liam","gadis","beni","zoe","bianca","azra","luana","conversational_bella","maurice","oliver","shruti","madhur","haroon","colin","zaina","sebastian","jeppe","narration_michael","agnieszka","jack","enric","omar","corey","delilah","liliana","amber","mason","laura","hillevi","narration_abbi","aysel","wilbur","dariya","leni","srecko","valentina","gerard","wren","andrea","ezinne","myra","karla","yunjhe","hila","roger","noah","blake","kalina","isabella","salman","marcus","geena","myriam","rok","promo_ava","klarissa","conversational_ava","alonso","amal","lucinda","narration_paula","hunter","niwat","estrella","nancy","elora","antoine","noura","zariyah","duarte","saumya","pallavi","ostap","siti","aspen","aria","sienna","berna","promo_tilda","madina","amelia","iselin","christabel","elvira","dhananjay","harri","conversational_kai","derek","francisca","isla","beatriz","erika","sloane","jenny","hollie","fenna","fahed","michael","jazmin","hugh","narek","jollie","henri","andrew","cicely","kirsi","zofia","rosa","ona","narration_tristan","narration_oliver","promo_sofia","barnaby","bran","bassel","sofie","chandler","mercedes","amala","mouna","lolita","zuri","sarahi","paola","irma","guadalupe","natasha","diana","horacio","gudrun","lukas","baozhai","gerald","borislav","tadeu","bronson","yoselin","isaac","michelle","pauline"]},"meta":{"version":"3.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested text-to-speech files listed below","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/content/file/create-upload-url":{"description":"\n## Product Description\n\nThe file service allows you to upload your existing files into our ecosystem. Currently only audio files are supported.\n\n","post":{"tags":["File"],"operationId":"postFile","summary":"Creates a url for uploading a new file.","description":"\nWhen uploading a file you should call this endpoint first. In the response a `uploadUrl` is returned. The user is required to make a `PUT` request to this url to upload the raw binary file. The URL is valid for 7 days and does not require authentication. Once consumed the URL is no longer valid.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filePath"],"properties":{"filePath":{"type":"string","description":"File path in the backend where the file will be created. Arbitrary folder paths are supported, and folders not yet created will be created."},"category":{"type":"string","description":"An arbitrary category for this file."},"tags":{"type":"array","description":"A list of tags in string format"},"source":{"type":"string","description":"By default this will be the client used to upload i.e. api, sdk"},"metadata":{"type":"object","description":"Freeform object for representing metadata"}}}}}},"responses":{"200":{"description":"presigned upload url created","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"fileId":{"type":"string"},"fileUploadUrl":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"fileId":"be64c426-18cd-49c8-b49b-3055ceb6df5f","fileUploadUrl":"******************"},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Upload url created. Please make a PUT request to the returned 'fileUploadUrl' with your binary payload.","warnings":[]}}}}},"400":{"description":"Failed to create upload url","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["the JSON object must be str, bytes or bytearray, not NoneType"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create upload url","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"413":{"description":"Failed to create upload url","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Your storage is full. Max size is 51200mb"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create upload url","warnings":[]}}}}},"415":{"description":"Failed to create upload url","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["file extension is not recognised `porn`"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create upload url","warnings":[]}}}}},"422":{"description":"Failed to create upload url","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["tags: Input should be a valid list"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create upload url","warnings":[]}}}}}}}},"/content/file/transfer-file":{"description":"\n## Product Description\n\nThe file service allows you to upload your existing files into our ecosystem. Currently only audio files are supported.\n\n","put":{"tags":["File"],"operationId":"postFileTransfer","summary":"Transfers a file created in the audiostack api","description":"the supplied url should be a valid url returned from any audiostack endpoint, i.e. tts, delivery and in the format  `https://v2.api.audio/file/..`. ","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filePath","url"],"properties":{"filePath":{"type":"string","description":"File path in the backend where the file will be created. Arbitrary folder paths are supported, and folders not yet created will be created. There is no need to supply the extension on transferred files."},"category":{"type":"string","description":"An arbitrary category for this file."},"tags":{"type":"array","description":"A list of tags in string format"},"metadata":{"type":"object","description":"Freeform object for representing metadata"},"url":{"type":"string","description":"A valid url in the format: https://v2.api.audio/file/.."}}}}}},"responses":{"202":{"description":"file transferred","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"fileId":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"fileId":"f616cb26-0472-441c-aed8-1e48a19287e2"},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"File is being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"400":{"description":"Failed to transfer file","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["the JSON object must be str, bytes or bytearray, not NoneType"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to transfer file","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"Failed to transfer file","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["url not found"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to transfer file","warnings":[]}}}}}}}},"/content/file/search":{"description":"List all uploaded files","get":{"tags":["File"],"operationId":"searchFiles","summary":"Search for files.","parameters":[{"in":"query","name":"path","schema":{"type":"string"}},{"in":"query","name":"source","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"tags","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"fileType","schema":{"type":"string"}},{"in":"query","name":"category","schema":{"type":"string"}},{"in":"query","name":"sortBy","schema":{"type":"string"}}],"responses":{"200":{"description":"Files listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"folders":{"type":"array"},"files":{"type":"array"},"nextToken":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"422":{"description":"Invalid query","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}}}}},"/content/file/id/{fileId}":{"get":{"tags":["File"],"operationId":"getFileId","summary":"Get a file object and creates a url for downloading it.","parameters":[{"in":"path","name":"fileId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileId retrieved","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"category":{"type":"string"},"dateCreated":{"type":"integer"},"source":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileId":{"type":"string"},"metadata":{"type":"object","properties":{}},"extension":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"url":"******************","tags":["a","b"],"status":"complete","category":"default","dateCreated":123,"source":"api","fileType":"audio","filePath":"assets/1.wav","fileId":"0","metadata":{},"extension":".wav"},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested fileId is not yet uploaded","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"202":{"description":"FileId processing","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested fileId is not yet uploaded","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"400":{"description":"The item uploaded could not be processed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["x does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find media file","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"file not found","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["x does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find media file","warnings":[]}}}}},"422":{"description":"The item uploaded could not be processed. Please check your file is of a supported type","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["x does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find media file","warnings":[]}}}}}}},"delete":{"tags":["File"],"operationId":"deleteFileId","summary":"Deletes a file.","parameters":[{"in":"path","name":"fileId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileId deleted","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Removed fileId: 54dc9fc0-931f-4a13-ab6b-bd09af8a1489","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}},"patch":{"tags":["File"],"operationId":"patchFile","summary":"Updates a file resource","description":"This endpoint allows you to update the supplied fields, filePath can be used to move the supplied file between folders","parameters":[{"in":"path","name":"fileId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filePath":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array"},"metadata":{"type":"object"}}}}}},"responses":{"200":{"description":"FileId retrieved","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"category":{"type":"string"},"dateCreated":{"type":"integer"},"source":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileId":{"type":"string"},"metadata":{"type":"object","properties":{}},"extension":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"url":"******************","tags":["a","b"],"status":"complete","category":"default","dateCreated":123,"source":"api","fileType":"audio","filePath":"assets/1.wav","fileId":"0","metadata":{},"extension":".wav"},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested fileId is not yet uploaded","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"202":{"description":"FileId processing","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested fileId is not yet uploaded","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"400":{"description":"Failed to patch file","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["123 does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find file","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"Failed to patch file","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["123 does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find file","warnings":[]}}}}},"422":{"description":"Failed to patch file","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["123 does not exist"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find file","warnings":[]}}}}}}}},"/content/folder":{"get":{"tags":["Folder"],"operationId":"listFolder","summary":"List a folder structure","parameters":[{"in":"query","name":"folder","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Folders listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"array"},"status":{"type":"string"},"category":{"type":"string"},"dateCreated":{"type":"integer"},"dateModified":{"type":"integer"},"source":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileId":{"type":"string"},"metadata":{"type":"object","properties":{}},"extension":{"type":"string"},"userId":{"type":"string"},"size":{"type":"integer"},"fileMetadata":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object","properties":{}}}}}}},"files":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"category":{"type":"string"},"dateCreated":{"type":"integer"},"dateModified":{"type":"integer"},"source":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileId":{"type":"string"},"metadata":{"type":"object","properties":{}},"extension":{"type":"string"},"userId":{"type":"string"},"size":{"type":"integer"},"fileMetadata":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object","properties":{"length":{"type":"number"}}}}}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}}}}}},"422":{"description":"Folder creation failed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["cannot reverse directory structure"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"failed to list folder structure","warnings":[]}}}}}}},"delete":{"tags":["Folder"],"operationId":"deleteFolder","summary":"Deletes a folder.","description":"Deletes a folder and all files within it. For safety root cannot be deleted.","parameters":[{"in":"query","name":"folder","required":true,"schema":{"type":"string"}},{"in":"query","name":"forceDelete","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Folder created","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"folder deleted","warnings":[]}}}}},"422":{"description":"Folder creation failed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["cannot reverse directory structure"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"failed to delete folder structure","warnings":[]}}}}}}},"post":{"tags":["Folder"],"operationId":"createFolder","summary":"Creates an empty folder","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder"],"properties":{"folder":{"type":"string"}}}}}},"responses":{"200":{"description":"Folder created","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"folder":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"folder":"___TEST/abc"},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Empty folder created ","warnings":[]}}}}},"400":{"description":"Folder creation failed","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["extension detected"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create folder","warnings":[]}}}}}}}},"/speech/voice-builder":{"description":"See here for more information: https://docs.audiostack.ai/docs/voice-cloning","post":{"operationId":"voiceBuilder","requestBody":{"content":{"application/json":{"schema":{"properties":{"fileIds":{"type":"array","items":{"type":"string"},"description":"List of fileIds to be used in cloning."},"alias":{"type":"string","description":"Alias for the cloned voice. You'll be able to use this alias when requesting TTS. Has to be globally unique."},"voiceEngine":{"type":"string","enum":["voice_engine_2","voice_engine_3"],"description":"Voice engine to be used in cloning."},"consentFileId":{"type":"string","description":"FileId of the consent file, speaker stating they agree to have their voice cloned. Required for voice_engine_2."},"metadata":{"type":"object","items":{"type":"string"},"description":"Metadata for the cloned voice. It's recommended to include \"gender\" and \"languageCode\"."}},"required":["fileIds","alias","voiceEngine"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","items":{"properties":{"cloneId":{"type":"string"},"voiceEngine":{"type":"string"},"alias":{"type":"string"},"filesUsed":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["preparing","in_progress","succeeded","failed"]},"startedAt":{"type":"integer"},"orgId":{"type":"string"},"userId":{"type":"string"},"providerId":{"type":"string","default":"Not available yet."},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"finishedAt":{"type":"integer","default":null},"failReason":{"type":"string","default":null},"discardedFiles":{"type":"object"}}}},"message":{"type":"string"},"meta":{"properties":{"creditsRemaining":{"type":"number"},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"},"version":{"type":"string"}},"type":"object"},"warnings":{"type":"array","items":{"type":"string"}}}}}},"description":"Clone job has been accepted and is being processed."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"message":{"type":"string"},"meta":{"properties":{"creditsRemaining":{"type":"number"},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"},"version":{"type":"string"}},"type":"object"},"warnings":{"type":"array"}}}}},"description":"Bad request."},"403":{"content":{"application/json":{"schema":{"example":{"message":"Access denied. Could not find a valid organization."},"properties":{"message":{"type":"string"}}}}},"description":"Could not find a valid api key"}},"summary":"Clones a voice from a list of files.","tags":["Voice Cloning"]},"get":{"operationId":"listVoiceBuilder","parameters":[{"name":"alias","in":"query","required":false,"schema":{"type":"string"},"description":"Alias of the cloned voice."}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cloneId":{"type":"string"},"voiceEngine":{"type":"string"},"alias":{"type":"string"},"filesUsed":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["preparing","in_progress","succeeded","failed"]},"startedAt":{"type":"integer"},"orgId":{"type":"string"},"userId":{"type":"string"},"providerId":{"type":"string","default":"Not available yet."},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"finishedAt":{"type":"integer","default":null},"failReason":{"type":"string","default":null},"discardedFiles":{"type":"object"}},"type":"object"},"message":{"type":"string"},"meta":{"properties":{"creditsRemaining":{"type":"number"},"creditsUsed":{"type":"integer"},"requestId":{"type":"string"},"version":{"type":"string"}},"type":"object"},"warnings":{"type":"array"}}}}},"description":"Projects returned"},"403":{"content":{"application/json":{"schema":{"example":{"message":"Missing authentication token. There might be no such route or method."},"properties":{"message":{"type":"string"}}}}},"description":"Could not find a valid api key"}},"summary":"Lists all Voice Cloning jobs done within your organisation.","tags":["Voice Cloning"]}},"/content/recommend/tag":{"post":{"tags":["Recommend"],"operationId":"postRecommendTags","summary":"Get recommended tags from user-specified list","description":"\n## Recommend tags\n\nThis endpoint allows the user to provide their own list of tags.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text","tags"],"properties":{"text":{"type":"string","description":"Text to get tags recommendations for."},"number_of_results":{"type":"integer","minimum":1,"title":"Number Of Results","default":1,"description":"Number of tags to get back."},"category":{"type":"string","title":"Category","default":"","description":"User specified category."},"tags":{"type":"array","items":{"type":"string"},"title":"Tags","description":"User specified list of tags to use"}}}}}},"responses":{"200":{"description":"Successful call","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"tag":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"tags":[{"category":"tag","tag":"valuable"},{"category":"tag","tag":"happy"}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"ok","warnings":[]}}}}},"422":{"description":"Empty list of tags","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Unprocessable Entity"],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Unprocessable Entity","warnings":[]}}}}}}}},"/content/recommend/tone":{"post":{"tags":["Recommend"],"operationId":"postRecommendTones","summary":"Get recommended tones","description":"\n## Recommend tones\n\nThis endpoint recommends the best `tone` from AudioStack's curated list of available tones. Tones are important for finding the best fitting `voice` for your text.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Text to get tone recommendations for."},"number_of_results":{"type":"integer","minimum":1,"title":"Number Of Results","default":1,"description":"Number of tags to get back."}}}}}},"responses":{"200":{"description":"Successful call","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"tag":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"tags":[{"category":"tone","tag":"balanced"},{"category":"tone","tag":"informative"}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"ok","warnings":[]}}}}},"422":{"description":"Empty text","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Unprocessable Entity"],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Unprocessable Entity","warnings":[]}}}}}}}},"/content/recommend/mood":{"post":{"tags":["Recommend"],"operationId":"postRecommendMoods","summary":"Get recommended moods","description":"\n## Recommend moods\n\nThis endpoint recommends the best `mood` from AudioStack's curated list of available tones. Moods are important for finding the best fitting `sound design` for your text.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Text to get mood recommendations for."},"number_of_results":{"type":"integer","minimum":1,"title":"Number Of Results","default":1,"description":"Number of tags to get back."}}}}}},"responses":{"200":{"description":"Successful call","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"},"category":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"tags":[{"tag":"cool","category":"mood"},{"tag":"exciting","category":"mood"}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"ok","warnings":[]}}}}},"422":{"description":"Empty text","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Unprocessable Entity"],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Unprocessable Entity","warnings":[]}}}}}}}},"/content/recommend/iab_category":{"post":{"tags":["Recommend"],"operationId":"postRecommendIABCategory","summary":"Get recommended IAB category","description":"\n## Recommend IAB category\n\nThis endpoint suggests IAB categories from the IAB's Official Content Taxonomy (version 3.0), with multiple tiers of granularity. The `tag` field contains the most specific label assigned to the content, while tier 1 to tier 3 represent progressively broader categories. The `simpleTag` field provides a simplified, user-friendly category, defined by Audiostack, which maps the classification to a broader content area.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Text to get IAB categories for."},"num_tags":{"type":"integer","minimum":1,"title":"Number Of Results","default":3,"description":"Number of IAB tags to get back."},"language":{"type":"string","default":"en","description":"2-letter language code for text - e.g. `en`"}}}}}},"responses":{"200":{"description":"Successful call","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"tag":{"type":"string"},"tier1":{"type":"string"},"tier2":{"type":"string"},"tier3":{"type":"string"},"simpleTag":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"tags":[{"category":"iab","tag":"Audio Production","tier1":"Hobbies & Interests","tier2":"Content Production","tier3":"Audio Production","simpleTag":"Arts, Media & Sports"},{"category":"iab","tag":"Digital Audio","tier1":"Technology & Computing","tier2":"Computing","tier3":"Computer Software and Applications","simpleTag":"Technology"},{"category":"iab","tag":"Software and Applications","tier1":"Technology & Computing","tier2":"Computing","tier3":"Computer Software and Applications","simpleTag":"Technology"}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Categorization Successful","warnings":[]}}}}},"422":{"description":"Empty text","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Text input must be a non-empty string."],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Invalid input","warnings":[]}}}}}}}},"/production/suite/enhance":{"description":"Evaluate audio file given a `fileId` and enhance audio quality based on the results of this evaluation","post":{"tags":["Suite"],"operationId":"enhanceAudio","summary":"Evaluate and enhance an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"scriptId":{"type":"string","description":"ScriptId for the text to check the words read in the recording against."},"text":{"type":"string","description":"Text to compare the words read in the recording against."},"preset":{"type":"string","default":"strict","description":"Preset for strictness of the evaluation, available presets are `low`, `medium`, `strict`"},"language":{"type":"string","default":"en-US","description":"language code of choice, i.e. `en-US` "}},"required":["fileId"]}}}},"responses":{"202":{"description":"Audio denoised","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241838,"pipelineId":"1785df02-ceaa-4800-a1f7-23d5fbe808cb","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/denoise":{"description":"Denoise an audio file in order to remove background noise.","post":{"tags":["Suite"],"operationId":"denoiseAudio","summary":"Denoise an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"level":{"type":"integer","description":"The amount of de-noising level between 0-2"}},"required":["fileId"]}}}},"responses":{"202":{"description":"Audio denoised","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241843,"pipelineId":"a6e0ae16-6245-4faf-b716-69bf5de8025f","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/speed-adjust":{"description":"Speeds up a supplied file (time stretch)","post":{"tags":["Suite"],"operationId":"speedAdjustAudio","summary":"Speed up an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"ratio":{"type":"number","description":"The amount to speed up by whereby 1.0 is no affect"},"maxLength":{"type":"number","description":"The max length that the file can be in seconds. Note this overrides ratio."}},"required":["fileId"]}}}},"responses":{"202":{"description":"Audio denoised","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241847,"pipelineId":"43d83af3-cd81-4937-bd1f-26350aae76e0","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/silence-trim":{"description":"Trims silence from an audio file in order to shorten it.","post":{"tags":["Suite"],"operationId":"SilenceTrimAudio","summary":"Trim an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"minSilenceDuration":{"type":"number","description":"The minimum of silence to remove (default 0.1)"},"silenceThreshold":{"type":"number","description":"the threshold below which will be counted as silence. (default 0.01 = -36db)"},"trimType":{"type":"string","description":"valid options are 'all', 'start' or 'end'"}},"required":["fileId"]}}}},"responses":{"202":{"description":"Audio denoised","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241852,"pipelineId":"e7550bd2-74fa-4281-9b08-a96c52b2b9bc","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/separate":{"description":"Separates an audio file into its original audio components (tracks, or sources)","post":{"tags":["Suite"],"operationId":"separateAudio","summary":"Separate an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"}},"required":["fileId"]}}}},"responses":{"202":{"description":"Audio separated","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241863,"pipelineId":"9678a8e5-d887-4c7f-8090-eafc307b8d52","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to separate","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to prepare task","warnings":[],"errors":["empty body"]}}}}},"404":{"description":"failed to separate","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"failed to prepare task","warnings":[],"errors":["could not find supplied fileId"]}}}}}}}},"/production/suite/transcribe":{"description":"Transcribes an audio file","post":{"tags":["Suite"],"operationId":"transcribeAudio","summary":"Transcribe an audio file.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"language":{"type":"string","description":"2-letter language code for audio - e.g. `en`"}},"required":["fileId","language"]}}}},"responses":{"202":{"description":"Audio transcribed","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241868,"pipelineId":"c116cf9d-ddf0-4fee-b20b-fa7f1c7150bc","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"Failed to transcribe - invalid request body","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Failed to transcribe - invalid fileId","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/file_to_video":{"description":"Generates a video using the provided fileId and an image or a fileId and videoFileId","post":{"tags":["Suite"],"operationId":"createVideo","summary":"Create a video.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fileId":{"type":"string","description":"fileId"},"videoFileId":{"type":"string","description":"Video file id"},"mode":{"type":"string","description":"Including the key 'settings' of possible values low or high"}},"required":["fileId"]}}}},"responses":{"202":{"description":"Video created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Task being processed","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"status":202,"dateCreated":1733241876,"pipelineId":"2b28f474-86f9-488b-8172-bfb5b3c49096","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[]}}}}}},"400":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"failed to denoise","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/pipeline/{pipelineId}":{"get":{"tags":["Suite"],"operationId":"getPipelineId","summary":"Retrieve a pipeline resource.","parameters":[{"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"In progress","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"newFileIds":{"type":"array"},"replacedFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}},"data":{"type":"object","properties":{}},"inputFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Pipeline finished","warnings":[],"data":{"status":200,"dateCreated":1733241885,"pipelineId":"6e355fb5-f9c2-4b2e-8441-0177d1b2b7a5","results":{"newFileIds":[],"replacedFileIds":[{"fileId":"2e2aadfb-abe8-441a-abff-5dfaf03e2efd","filePath":"tests/fixtures/noisy_file_(404).wav","label":"default"}],"data":{},"inputFileIds":[{"fileId":"2e2aadfb-abe8-441a-abff-5dfaf03e2efd","filePath":"tests/fixtures/noisy_file_(404).wav","label":"default"}]},"message":"complete","errors":[]}}}}}},"202":{"description":"In progress","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"newFileIds":{"type":"array"},"replacedFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}},"data":{"type":"object","properties":{}},"inputFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}}}},"message":{"type":"string"},"errors":{"type":"array"}}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"Failed","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/production/suite/videopipeline/{pipelineId}":{"get":{"tags":["Suite"],"operationId":"getVideoPipelineId","summary":"Retrieve a video pipeline resource.","parameters":[{"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"In progress","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"newFileIds":{"type":"array"},"replacedFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}},"data":{"type":"object","properties":{}},"inputFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}}}},"message":{"type":"string"},"errors":{"type":"array"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Pipeline finished","warnings":[],"data":{"status":200,"dateCreated":1733241895,"pipelineId":"65d2c567-1534-4e36-8d5c-cd990b39c77d","results":{"newFileIds":[],"replacedFileIds":[{"fileId":"9e54094c-02a3-4b21-b9f4-3778093c0085","filePath":"tests/fixtures/noisy_file_(405).wav","label":"default"}],"data":{},"inputFileIds":[{"fileId":"9e54094c-02a3-4b21-b9f4-3778093c0085","filePath":"tests/fixtures/noisy_file_(405).wav","label":"default"}]},"message":"complete","errors":[]}}}}}},"202":{"description":"In progress","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"newFileIds":{"type":"array"},"replacedFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}},"data":{"type":"object","properties":{}},"inputFileIds":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"type":"string"},"label":{"type":"string"}}}}}},"message":{"type":"string"},"errors":{"type":"array"}}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"Failed","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"/delivery/encoder":{"description":"\n## Product Description\n\nOut Delivery endpoints put the finishing touches on your mixed audio assets. Our encoder can be used to convert your file into a different format i.e. `mp3`. Our connector endpoints allow you to publish these assets onwards.\n\n","post":{"tags":["Encoder"],"operationId":"postEncoder","summary":"Changes the audio encoding of a mixed audio file","description":"\nFor most use cases, the preset can be either `custom` or one of the values returned from the `/encoder/presets` list. When using `custom` the other fields can be supplied. Please note not all fields are supported in conjunction with one another. For example `sampleRate` cannot be used in conjunction with `bitRateType`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"productionId":{"type":"string","description":"Reference to the productionId that is to be encoded"},"preset":{"type":"string","description":"named preset to use or 'custom'. Available presets can be listed using '/delivery/encoder/presets'"},"public":{"type":"boolean","description":"Make the output a publicly available URL "},"bitRateType":{"type":"string","description":"Supplied value must be either 'constant' or 'variable"},"bitRate":{"type":"string","description":"Can be between 0-9 for variable bit rates, or between 32 and 320 for constant bit rates"},"sampleRate":{"type":"integer","description":"Sample rate, should be between 24000 and 96000"},"format":{"type":"string","description":"Can be wav, mp3, flac or ogg"},"bitDepth":{"type":"integer","description":"Can be 16, 24, or 32"},"channels":{"type":"integer","description":"Supply 1 for mono or 2 for stereo"},"loudnessPreset":{"type":"string","description":"Name of loudness preset to use for example 'podcast' or 'spotify'. Available presets can be listed using '/delivery/encoder/presets'"}},"required":["productionId"]}}}},"responses":{"200":{"description":"Encoded mix created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"url":{"type":"string"},"format":{"type":"string"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Encoded successfully","warnings":[],"data":{"url":"******************","format":"mp3"}}}}}},"400":{"description":"Encoded mix could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Invalid request","warnings":[],"errors":["1 validation error for Input\npreset\n  Value error, Invalid preset value supplied. use /encoder/presets (GET) to list valid presets [type=value_error, input_value='best_mix', input_type=str]\n    For further information visit https://errors.pydantic.dev/2.9/v/value_error"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"405":{"description":"At least one of speechId or productionId should be supplied","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to encode audio","warnings":[],"errors":["At least one of speechId or productionId should be supplied."]}}}}}}}},"/delivery/video":{"description":"\n## Product Description\n\nOut Delivery endpoints put the finishing touches on your mixed audio assets. Our encoder can be used to convert your file into a different format i.e. `mp3`. Our connector endpoints allow you to publish these assets onwards.\n\n","post":{"tags":["Video"],"operationId":"postVideo","summary":"Create video","description":"\nCreate a video for a given `productionId`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"productionId":{"type":"string","description":"Reference to the productionId that is to be encoded"},"public":{"type":"boolean","description":"Make the output a publicly available URL "}},"required":["productionId"]}}}},"responses":{"200":{"description":"Video created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"url":{"type":"string"},"format":{"type":"string"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Video processed successfully","warnings":[],"data":{"url":"******************","format":"mp4"}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"405":{"description":"Video could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to generate video","warnings":[],"errors":["productionId should be supplied."]}}}}}}}},"/delivery/connectors/julep":{"description":"\nJulep is a podcast hosting platform based in Germany. On top of hosting your audio content, they also offer monetization and their own, embeddable player. In order to use this connector you’ll need an account with Julep.\n\nTo authenticate with julep we recommend you do this through the Audiostack console.\n","post":{"tags":["Julep"],"operationId":"postJulep","summary":"Sends a produced file to Julep connector","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"productionId":{"type":"string","description":"Reference to the productionId that is to be delivered to the connector"},"podcastId":{"type":"string","description":"Id of the podcast"},"title":{"type":"string","description":"Title of podcast"},"permalink":{"type":"string","description":"permalink for podcast"},"subtitle":{"type":"string","description":"Subtitle for podcast"},"description":{"type":"string","description":"podcast description"},"notes":{"type":"string","description":"notes for the podcast"},"publishedAt":{"type":"string","description":"Changes the date of publication. publishedAt parameter should be in YYYY-MM-DD HH:MM:SS format."}},"required":["productionId","podcastId","title","permalink"]}}}},"responses":{"202":{"description":"Delivery started","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"data":{"type":"object","properties":{"deliveryId":{"type":"string"}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Julep episode upload started","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."],"data":{"deliveryId":"2b19b4fc-b694-416c-89df-cb87bb53c945"}}}}}},"401":{"description":"Delivery could not be created, see errors","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Failed to load credentials"],"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to authenticate","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"405":{"description":"Delivery could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to validate body","warnings":[],"errors":["3 validation errors for JulepBody\npodcastId\n  Field required [type=missing, input_value={'productionId': 'a3995de...4cc9-a9fa-1c155f086069'}, input_type=dict]\n    For further information visit https://errors.pydantic.dev/2.9/v/missing\ntitle\n  Field required [type=missing, input_value={'productionId': 'a3995de...4cc9-a9fa-1c155f086069'}, input_type=dict]\n    For further information visit https://errors.pydantic.dev/2.9/v/missing\npermalink\n  Field required [type=missing, input_value={'productionId': 'a3995de...4cc9-a9fa-1c155f086069'}, input_type=dict]\n    For further information visit https://errors.pydantic.dev/2.9/v/missing"]}}}}}}}},"/delivery/connectors/authenticate-julep":{"put":{"tags":["Julep"],"operationId":"putJulepCredentials","summary":"Authenticates with Julep","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"username":{"type":"string","description":"Julep username"},"password":{"type":"string","description":"Julep password"}},"required":["username","password"]}}}},"responses":{"200":{"description":"Authenticated","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{},"meta":{"version":"2.0.0","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"authenticated","warnings":[]}}}}},"401":{"description":"failed to authenticate","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to authenticate","warnings":[],"errors":["Failed to load credentials"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/delivery/connectors/status":{"get":{"tags":["Connector"],"operationId":"listConnectorDeliveries","summary":"Lists all connected deliveries.","responses":{"200":{"description":"List of delivered connections","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"deliveries":{"type":"array","items":{"type":"object","properties":{"orgId":{"type":"string"},"response":{"type":"object","properties":{"episodeId":{"type":"integer"},"playerContentLink":{"type":"string"}}},"deliveryId":{"type":"string"},"connectorType":{"type":"string"},"statusCode":{"type":"integer"}}}}}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/delivery/connectors/status/{deliveryId}":{"get":{"tags":["Connector"],"operationId":"getConnectorDelivery","summary":"Get a single delivery.","parameters":[{"in":"path","name":"deliveryId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delivery status","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"orgId":{"type":"string"},"deliveryId":{"type":"string"},"connectorType":{"type":"string"},"statusCode":{"type":"integer"},"response":{"type":"object","properties":{"episodeId":{"type":"integer"},"playerContentLink":{"type":"string"}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"deliverable retrieved.","warnings":[],"data":{"orgId":"******************","deliveryId":"0c99dd3e-d104-421d-b8a6-4505a6612203","connectorType":"julep","statusCode":200,"response":{"episodeId":195386,"playerContentLink":"https://cdn.julephosting.de/podcasts/1004-testdebug/195386-episode.json?v=1"}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"Delivery status","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to retrieve deliverable","warnings":[],"errors":["Not found"]}}}}}}}},"/delivery/encoder/presets":{"get":{"tags":["Encoder"],"operationId":"listEncoderPresets","summary":"Lists available encoder presets and loudness presets","responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"presets":{"type":"object","properties":{"mp3":{"type":"string"},"wav":{"type":"string"},"ogg":{"type":"string"},"flac":{"type":"string"},"mp3_very_low":{"type":"string"},"mp3_low":{"type":"string"},"mp3_medium":{"type":"string"},"mp3_high":{"type":"string"},"mp3_very_high":{"type":"string"},"mp3_alexa":{"type":"string"},"mp3_alexa_48br":{"type":"string"},"m4a":{"type":"string"}}},"loudnessPresets":{"type":"object","properties":{"spotify":{"type":"string"},"radio":{"type":"string"},"podcast":{"type":"string"},"applePodcast":{"type":"string"},"youtube":{"type":"string"},"lowVol":{"type":"string"},"podcastDynamic":{"type":"string"}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Valid presets listed below","warnings":[],"data":{"presets":{"mp3":"mp3 format 320k (320 CBR)","wav":"wav format at 48 kHz sample rate and 16 bits per sample","ogg":"ogg format at 320k","flac":"flac format at 48 kHz sample rate and 16 bits per sample","mp3_very_low":"mp3 lowest quality (~64 kbps VBR)","mp3_low":"mp3 low quality (~115 kbps VBR)","mp3_medium":"mp3 medium quality (~165 kbps VBR)","mp3_high":"mp3 high quality (~190 kbps VBR)","mp3_very_high":"mp3 very high quality (~245 kbps VBR)","mp3_alexa":"mp3 format mono at 48kHz sample rate","mp3_alexa_48br":"mp3 format mono at 48 bit rate and 24kHz sample rate","m4a":"m4a format at 320k"},"loudnessPresets":{"spotify":"-16 LUFS Loudness Integrated and -2 dB True Peak","radio":"-8 LUFS Loudness Integrated and -2 dB True Peak","podcast":"-16 LUFS Loudness Integrated and -3 dB True Peak","applePodcast":"-16 LUFS Loudness Integrated and -1 dB True Peak","youtube":"-14 LUFS Loudness Integrated and -1 dB True Peak","lowVol":"-20 LUFS Loudness Integrated and -5 dB True Peak","podcastDynamic":"-18 LUFS Loudness Integrated and -1 dB True Peak"}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/production/mix":{"description":"\n## Product Description\n\nOur production endpoints replicate the functionality of a recording studio. Mixing together multiple streams of audio and enhancing these with studio grade effects, such as ducking, de-essing, EQ and compression. You can use our `sectionProperties` argument to arrange sources across a virtual timeline, and align these to fixed markers.\n\n","post":{"tags":["Mixing"],"operationId":"postMix","summary":"Creates a mix of multiple audio resources.","description":"\ntodo\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"speechId":{"type":"string","description":"Reference to the speechId that is to be mixed with other audio resources"},"soundTemplate":{"type":"string","description":"Name of the sound template to be mixed with other audio resources"},"soundLayer":{"type":"string","description":"(Beta) Which layer of the sound template should be used"},"mediaFiles":{"type":"object","format":"{placeholder : mediaId }","description":"List of media files to be mixed with other audio resources"},"fxFiles":{"type":"object","format":"{placeholder : fxId }","description":"List of fx files to be mixed with other audio resources"},"public":{"type":"boolean","description":"Makes returned URLs publicly available"},"sectionProperties":{"type":"object","description":"\nSection properties exposes the following properties for each section. Note that the properties apply to all sub-sections also. \n```py\n{\n    \"<sectionName>\" : {\n        \"startAt\" : \"<time in seconds>\",\n        \"endAt\" : \"<time in seconds>\",\n        \"alignment\" : \"<left, centre or right>\",\n        \"fadeIn\" : \"<time in seconds>\",\n        \"fadeOut\" : \"<time in seconds>\",\n        \"padding\" : \"<time in seconds that is added after this script section>\"\n    }\n}\n```\n"},"timelineProperties":{"type":"object","description":"\nTimeline properties exposes the following properties for each section. Note that the properties apply to all sub-sections also. \n```py\n{\n    \"forceLength\" : \"<time in seconds that the resultant file will be>\",\n    \"speechStart\" : \"<time in seconds that the speech track will start>\",\n    \"soundTail\" : \"<time in seconds that the sound template track will play at the end>\",\n    \"fadeIn\" : \"<time in seconds>\",\n    \"fadeOut\" : \"<time in seconds>\",\n    \"padding\" : \"<time in seconds that is added between each script section>\"\n}\n```\n"},"masteringPreset":{"type":"string","description":"Mastering preset to use, for example heavyDucking."},"strictValidation":{"type":"boolean","description":"To bypass timeline protection set this to false. Results may vary and sound files might overlap"},"exportSettings":{"type":"object","description":"\nExport settings can be used to export special audio assets from the mastering process. Currently the following flags are supported:\n\n`ttsTrack` - (true or false) will return the isolated voice track in the response.\n\n","properties":{},"additionalProperties":true}},"required":["speechId"]}}}},"responses":{"200":{"description":"Mix created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"productionId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"creationDate":{"type":"integer"},"fileLength":{"type":"number"},"timelineId":{"type":"string"},"timelineObject":{"type":"object","properties":{"timeline":{"type":"object","properties":{"tracks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"clips":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"source":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"file":{"type":"string"},"voice":{"type":"string"},"scriptText":{"type":"string"},"speed":{"type":"integer"},"maxLength":{"type":"object","properties":{"length":{"type":"number"},"unit":{"type":"string"}}}}}}},"position":{"type":"object","properties":{"mode":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"number"},"end":{"type":"number"}}},"unit":{"type":"string"}}},"looping":{"type":"integer"},"fades":{"type":"object","properties":{"fade_in":{"type":"number"},"fade_out":{"type":"number"},"unit":{"type":"string"}}},"readpos":{"type":"object","properties":{"units":{"type":"string"},"value":{"type":"integer"}}}}}},"id":{"type":"string"},"audio":{"type":"object","properties":{"gain":{"type":"number"},"pan_l":{"type":"number"},"pan_r":{"type":"number"},"flip_phase":{"type":"integer"}}}}}},"position":{"type":"object","properties":{"mode":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"number"}}},"unit":{"type":"string"}}},"autoVolume":{"type":"integer"},"fades":{"type":"object","properties":{"fade_in":{"type":"number"},"fade_out":{"type":"number"},"unit":{"type":"string"}}},"masteringPreset":{"type":"string"},"sampleRate":{"type":"integer"},"timelineId":{"type":"string"}}},"timelineId":{"type":"string"}}},"files":{"type":"array","items":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"},"format":{"type":"string"},"url":{"type":"string"},"errors":{"type":"string"},"filename":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mix created","warnings":[],"data":{"productionId":"eee4d5e3-7010-41a4-b6b6-c89e335cfcaf","scriptId":"57f7ae14-6024-4b74-911f-feb457469080","scriptMetadata":{},"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","creationDate":1733242027,"fileLength":22.067097505668933,"timelineId":"6a2a6575-692a-415f-96ab-cdf2601e9f54","timelineObject":{"timeline":{"tracks":[{"name":"voice","clips":[{"id":"cade0f32-9d49-4332-a66a-da8ee839da8a","type":"clip","source":{"type":"voice","data":{"speechId":"90cd9849-067b-4c48-902a-9ff7e0b6bc96","file":"05b1cb19-5477-44fd-9777-f82c95095784.wav","voice":"joanna","scriptText":"hello this is the new script syntax","speed":1,"maxLength":{"length":2.351020408,"unit":"seconds"}}},"position":{"mode":"static","data":{"start":1,"end":3.351},"unit":"seconds"},"looping":false,"fades":{"fade_in":0.001,"fade_out":0.001,"unit":"seconds"},"readpos":{"units":"samples","value":0}},{"id":"03e85124-ec17-4b3e-9b1e-73d0aa7748c6","type":"clip","source":{"type":"voice","data":{"speechId":"90cd9849-067b-4c48-902a-9ff7e0b6bc96","file":"ce594aa3-dc5f-40af-ad76-92b8f0280ade.wav","voice":"joanna","scriptText":"This uses regular H T M L syntax and replaces our ...","speed":1,"maxLength":{"length":5.041632653,"unit":"seconds"}}},"position":{"mode":"static","data":{"start":6.0153,"end":11.057},"unit":"seconds"},"looping":false,"fades":{"fade_in":0.001,"fade_out":0.001,"unit":"seconds"},"readpos":{"units":"samples","value":0}},{"id":"087643f8-daa0-4f89-8ef1-6c7ef051cc8e","type":"clip","source":{"type":"voice","data":{"speechId":"90cd9849-067b-4c48-902a-9ff7e0b6bc96","file":"a0ae7cbb-9658-4eee-b3fa-bc32e8377741.wav","voice":"joanna","scriptText":"This massively improves usability, aids with learn...","speed":1,"maxLength":{"length":5.12,"unit":"seconds"}}},"position":{"mode":"static","data":{"start":12.0348,"end":17.1548},"unit":"seconds"},"looping":false,"fades":{"fade_in":0.001,"fade_out":0.001,"unit":"seconds"},"readpos":{"units":"samples","value":0}}],"id":"d5b5635e-fcdc-4ded-8426-2ed01df460be","audio":{"gain":0.8912,"pan_l":1,"pan_r":1,"flip_phase":false}},{"name":"sound","clips":[{"id":"cb29dd82-0781-44eb-8fc2-4ca8f6611ee7","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"intro-i"}},"position":{"mode":"static","data":{"start":0,"end":88485},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"4076e7ed-0303-4829-95dc-e982016cccbe","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"intro-f"}},"position":{"mode":"static","data":{"start":88485,"end":265278},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"c9af5482-03bf-48bc-84b0-895cdc2005c1","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"main-i"}},"position":{"mode":"static","data":{"start":265278,"end":353763},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"3b105d6d-0dcd-4ff8-88aa-7cce18a351dd","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"main-m"}},"position":{"mode":"static","data":{"start":353763,"end":442248},"unit":"samples"},"looping":true,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"240e872c-1b9a-4178-a9af-2c9269de9219","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"main-o"}},"position":{"mode":"static","data":{"start":442248,"end":530733},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"64d47460-eb83-45ea-92f0-8e808ab21e7e","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"outro-i"}},"position":{"mode":"static","data":{"start":530734,"end":619219},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"87cdf9c9-b707-4b92-9b85-023735695470","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"outro-m"}},"position":{"mode":"static","data":{"start":619219,"end":884674},"unit":"samples"},"looping":true,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}},{"id":"0e3e4dc5-ea51-4d4c-95da-abb7b0091b53","type":"clip","source":{"type":"sound","data":{"sound_template":"vinylhits","segment":"outro-o"}},"position":{"mode":"static","data":{"start":884674,"end":973159},"unit":"samples"},"looping":false,"fades":{"fade_in":0,"fade_out":0,"unit":"samples"},"readpos":{"units":"samples","value":0}}],"id":"9bfd963b-f1e2-4f5b-a3d8-295d6ebdd773","audio":{"gain":1,"pan_l":1,"pan_r":1,"flip_phase":false},"fades":{"fade_in":0.01,"fade_out":0.01,"unit":"seconds"}}],"position":{"mode":"static","data":{"start":0,"end":22.0671},"unit":"seconds"},"autoVolume":true,"fades":{"fade_in":0.1,"fade_out":1,"unit":"seconds"},"masteringPreset":"balanced","sampleRate":44100,"timelineId":"6a2a6575-692a-415f-96ab-cdf2601e9f54"},"timelineId":"6a2a6575-692a-415f-96ab-cdf2601e9f54"},"files":[{"statusCode":201,"message":"Mastering completed successfully","format":"wav","url":"******************","errors":"","filename":"primary"},{"statusCode":201,"message":"stems export","format":"zip","url":"******************","errors":"","filename":"stems"}]}}}}}},"400":{"description":"Mix could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mastering request failed to validate, invalid json or empty body","warnings":[],"errors":["Empty body or Invalid Json"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"SpeechId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mastering request failed to validate","warnings":[],"errors":["Failed to find speechId"]}}}}}}}},"/production/validate":{"post":{"tags":["Mixing"],"operationId":"validateMix","summary":"Validates that the requested mastering request is valid","description":"\nThis route can be used to check that the requested mastering request is valid. For example, ensure your timelineProperties and sectionProperties are valid.\nThe actual requests is not sent for processing, meaning you are not charged production credits for this feature.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"speechId":{"type":"string","description":"Reference to the speechId that is to be mixed with other audio resources"},"soundTemplate":{"type":"string","description":"Name of the sound template to be mixed with other audio resources"},"soundLayer":{"type":"string","description":"(Beta) Which layer of the sound template should be used"},"mediaFiles":{"type":"object","format":"{placeholder : mediaId }","description":"List of media files to be mixed with other audio resources"},"fxFiles":{"type":"object","format":"{placeholder : fxId }","description":"List of fx files to be mixed with other audio resources"},"public":{"type":"boolean","description":"Makes returned URLs publicly available"},"sectionProperties":{"type":"object","description":"\nSection properties exposes the following properties for each section. Note that the properties apply to all sub-sections also. \n```py\n{\n    \"<sectionName>\" : {\n        \"startAt\" : \"<time in seconds>\",\n        \"endAt\" : \"<time in seconds>\",\n        \"alignment\" : \"<left, centre or right>\",\n        \"fadeIn\" : \"<time in seconds>\",\n        \"fadeOut\" : \"<time in seconds>\",\n        \"padding\" : \"<time in seconds that is added after this script section>\"\n    }\n}\n```\n","properties":{},"additionalProperties":true},"timelineProperties":{"type":"object","description":"\nTimeline properties exposes the following properties for each section. Note that the properties apply to all sub-sections also. \n```py\n{\n    \"forceLength\" : \"<time in seconds that the resultant file will be>\",\n    \"speechStart\" : \"<time in seconds that the speech track will start>\",\n    \"soundTail\" : \"<time in seconds that the sound template track will play at the end>\",\n    \"fadeIn\" : \"<time in seconds>\",\n    \"fadeOut\" : \"<time in seconds>\",\n    \"padding\" : \"<time in seconds that is added between each script section>\"\n}\n```\n","properties":{},"additionalProperties":true},"masteringPreset":{"type":"string","description":"Mastering preset to use, for example heavyDucking."},"strictValidation":{"type":"boolean","description":"To bypass timeline protection set this to false. Results may vary and sound files might overlap"},"exportSettings":{"type":"object","description":"\nExport settings can be used to export special audio assets from the mastering process. Currently the following flags are supported:\n\n`ttsTrack` - (true or false) will return the isolated voice track in the response.\n\n","properties":{},"additionalProperties":true}},"required":["speechId"]}}}},"responses":{"200":{"description":"Mix created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mastering request is valid","warnings":[],"data":{}}}}}},"400":{"description":"Mix could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mastering request failed to validate, invalid json or empty body","warnings":[],"errors":["Empty body or Invalid Json"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"SpeechId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mastering request failed to validate","warnings":[],"errors":["Failed to find speechId"]}}}}}}}},"/production/mixes":{"get":{"tags":["Mixing"],"operationId":"listMixes","summary":"Lists multiple mixed resources.","description":"\nReturns a list of mixed files that have been created. Can be filtered by `projectName`, `moduleName`, `scriptName` and `scriptId`.\n","parameters":[{"in":"query","name":"projectName","schema":{"type":"string"}},{"in":"query","name":"moduleName","schema":{"type":"string"}},{"in":"query","name":"scriptName","schema":{"type":"string"}},{"in":"query","name":"scriptId","schema":{"type":"string"}},{"in":"query","name":"paginationToken","schema":{"type":"string"}},{"in":"query","name":"verbose","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"productionIds":{"type":"array"}}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"405":{"description":"Query parameters not configured","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to list mixed files","warnings":[],"errors":["ProjectName needs to be supplied to filter by moduleName."]}}}}}}}},"/production/mix/{productionId}":{"get":{"tags":["Mixing"],"operationId":"getProductionId","summary":"Retrieve a mixed resource.","parameters":[{"in":"path","name":"productionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mix returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"productionId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"creationDate":{"type":"integer"},"fileLength":{"type":"integer"},"timelineId":{"type":"string"},"timelineObject":{"type":"object","properties":{"timeline":{"type":"object","properties":{"masteringPreset":{"type":"string"},"timelineId":{"type":"string"},"position":{"type":"object","properties":{"mode":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"number"}}},"unit":{"type":"string"}}},"fades":{"type":"object","properties":{"fade_in":{"type":"number"},"fade_out":{"type":"integer"},"unit":{"type":"string"}}},"sampleRate":{"type":"integer"},"tracks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"audio":{"type":"object","properties":{"pan_r":{"type":"integer"},"pan_l":{"type":"integer"},"gain":{"type":"number"},"flip_phase":{"type":"integer"}}},"clips":{"type":"array","items":{"type":"object","properties":{"looping":{"type":"integer"},"id":{"type":"string"},"source":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object","properties":{"voice":{"type":"string"},"scriptText":{"type":"string"},"file":{"type":"string"},"speechId":{"type":"string"},"speed":{"type":"integer"},"maxLength":{"type":"object","properties":{"length":{"type":"number"},"unit":{"type":"string"}}}}}}},"position":{"type":"object","properties":{"mode":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"number"}}},"unit":{"type":"string"}}},"readpos":{"type":"object","properties":{"value":{"type":"integer"},"units":{"type":"string"}}},"type":{"type":"string"},"fades":{"type":"object","properties":{"fade_in":{"type":"number"},"fade_out":{"type":"number"},"unit":{"type":"string"}}}}}}}}},"autoVolume":{"type":"integer"}}},"timelineId":{"type":"string"}}},"files":{"type":"array","items":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"},"format":{"type":"string"},"url":{"type":"string"},"errors":{"type":"string"},"filename":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"mix retrieved","warnings":[],"data":{"productionId":"aed8a26f-d621-4717-9cc7-55272fa21744","scriptId":"410e6962-9bdd-45fe-9d28-38f0803d3ac1","scriptMetadata":{},"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","creationDate":1733242048,"fileLength":-1,"timelineId":"3785f0d2-e4e9-4d91-8e66-a2b271fbc2a5","timelineObject":{"timeline":{"masteringPreset":"balanced","timelineId":"3785f0d2-e4e9-4d91-8e66-a2b271fbc2a5","position":{"mode":"static","data":{"start":0,"end":6.0897},"unit":"seconds"},"fades":{"fade_in":0.1,"fade_out":1,"unit":"seconds"},"sampleRate":44100,"tracks":[{"name":"voice","id":"d2616907-cd1e-4824-98cd-69de22eb91d0","audio":{"pan_r":1,"pan_l":1,"gain":0.8912,"flip_phase":false},"clips":[{"looping":false,"id":"d9440821-5f10-4d47-b7f4-eb14e1217eb6","source":{"type":"voice","data":{"voice":"joanna","scriptText":"This is our first section of our script.","file":"c20c9570-d25d-41d3-a0b2-a5f3df005448.wav","speechId":"c2602d56-9c5c-4e4c-aae9-95ff0e760f81","speed":1,"maxLength":{"length":2.089795918,"unit":"seconds"}}},"position":{"mode":"static","data":{"start":1,"end":3.0897},"unit":"seconds"},"readpos":{"value":0,"units":"samples"},"type":"clip","fades":{"fade_in":0.001,"fade_out":0.001,"unit":"seconds"}}]}],"autoVolume":true},"timelineId":"3785f0d2-e4e9-4d91-8e66-a2b271fbc2a5"},"files":[{"statusCode":201,"message":"Mastering completed successfully","format":"wav","url":"******************","errors":"","filename":"primary"}]}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Mix not returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to retrieve mixed audio.","warnings":[],"errors":["productionId x not found"]}}}}}}},"delete":{"tags":["Mixing"],"operationId":"deleteProductionId","summary":"Deletes a mixed resource","parameters":[{"in":"path","name":"productionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mix deleted","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"productionId dba0fc0d-4ecf-470f-8514-eb49ff6e7936 deleted!","warnings":[],"data":{}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"Mix not returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"File was already deleted. productionId x not found!","warnings":[],"data":{}}}}}}}}},"/production/mix/presets":{"get":{"tags":["Mixing"],"operationId":"listMasteringPresets","summary":"Lists available mastering presets.","responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Mix presets listed below.","warnings":[],"data":{"presets":[{"name":"atmosphere_test","description":"Preset for loud music volume which combines ducking and saturation to create a balanced mix"},{"name":"balanced","description":"Preset for loud music volume which combines ducking and saturation to create a balanced mix"},{"name":"bypass","description":"Preset for radio aiming to reach great LI (loudness integrated) levels"},{"name":"mediaenhanced","description":"Preset for loud media track volume"},{"name":"musicenhanced","description":"Preset for loud music volume which combines ducking and saturation to create a balanced mix"},{"name":"none","description":"no post processing"},{"name":"podcast","description":"Smoother preset for podcasting"},{"name":"radio","description":"Preset for radio aiming to reach great LI (loudness integrated) levels"},{"name":"speechmedia","description":"Preset for loud music volume which combines ducking and saturation to create a balanced mix"},{"name":"test-plugin-chain-tim-new-format","description":"Automated plugin chain creation"},{"name":"voiceenhanced","description":"Preset for medium music volume which combines ducking and saturation to create a balanced mix"},{"name":"voiceleveler","description":"Preset for loud media track volume"},{"name":"voiceonly","description":"anoher preset for combining ducking and saturation to create a balanced mix"}]}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/content/script":{"description":"\n## Product Description\n\nSimply put, a script is the format that makes creating and audio with audiostacks, accessible, scalable and awesome. In summary a script contains a series of commands for producing beautifully rendered text-to-speech, that can later be mixed with custom media files and dynamically adjustable sound templates. In the most basic example, a script with the text ``hello world`` will permit our speech services #here to render a syntehtic rendition of the words ``hello world``.\n\nTo annotate a script we have a collection of *markup* syntax used to signify sections, sound effects, dictionary flags and more. All of our tags are prefixed with `as:` syntax (short for audiostack).\n\n### Sections\nAll scripts should start and end with a `<as:section>`\n\n```html\n<as:section name=\"hello\">\n    Hello world, this section is named hello. \n</as:section>\n```\n\n\nScripts not created without a section tag will have one generated automatically. A script can contain many sections, but sections cannot be nested. See `as:sub` for adding sub-sections.\n\n\nTo combine a speech file with a sound design, apply the `soundsegment` attribute to the `as:section` tag.\n\n```html\n<as:section name=\"intro\" soundsegment=\"intro\">\n    This is the first section and will be combined with the intro music.\n</as:section>\n\n<as:section name=\"main\" soundsegment=\"main\">\n    This is the second section and will be combined with the main music. The section name and soundsegment don't have to have the same name.\n</as:section>\n```\n\n### Sub-sections\nTo insert sub-sections you need to use the `<as:sub>` tag. By default all sub-sections will be rendered with the same voice, but this can be configured in the speech call. However all the tts content with the section will be combined with the supplied sound segment. Sub-sections cannot be nested.\n\n```html\n<as:section name=\"intro\" soundsegment=\"intro\">\n    <as:sub name=\"introa\"> This is sub-section 1 </as:sub>\n    <as:sub name=\"introb\"> This is sub-section 2 </as:sub>\n</as:section>\n```\n\n### Media and FX\n\nTo create awesome audio content you can also insert sound effects and media files. Conceptually these work the same, fx are sound effects that we have curated for you, and media files can be user-uploaded. The tags for these are very similar.\n\n```html\n<as:section name=\"intro\" soundsegment=\"intro\">\n    Hello and welcome to my awesome audio advert \n    <as:fx name=\"bang\" id=\"fx1\"/>\n    I have also uploaded my companies sound branding which will now play.\n    <as:media name=\"branding1\" id=\"branding\"/>\n</as:section>\n```\n\nUse the `name` if you wish to use a named asset. Use the `id` tag if you wish to swap the content in a future mastering request without recreating the script. Note that either `name` or `id` must be supplied.\n\n### Placeholders\n\nTo produce variants of a single script you can use the `as:placeholder` tag to insert content during a speech creation call. \n\n```html\n<as:section name=\"intro\" soundsegment=\"intro\"> \n    hello enjoy a coffee with <as:placeholder id=\"username\">name</as:placeholder>\n</as:section>\n```\n\nThe content between the placeholder tag is the default content that will be used, the `id` parameter is used to replace this content during the speech call. For example, setting username=\"sam\".\n\nFor reference these are all the audiostack specific ssml tags.\n```html\n    <as:section name=\"main\" soundSegment=\"main\"> hello </as:section>\n    <as:sub name=\"main\"> hello </as:sub>\n    <as:fx name=\"riser\" id=\"fx1\" /> \n    <as:media name=\"soundbranding.wav\" id=\"media1\" />\n    <as:placeholder id=\"username\"> fallback </as:placeholder> \n    <as:preserve> This text will not be corrected by voice intelligence service </as:preserve>\n```\n\n### SSML\nSSML stands for Speech Synthesis Markup Language, and many TTS providors supply a collection of these tags for customising the sonice rendering of TTS voices, for example, changing prosidy, speaking speed, or inserting pauses between words. The syntax is ``<SSMLTagName parameters> ``, for a comprehensive list of SSML tags see this helpful guide.\n\n","post":{"tags":["Script"],"operationId":"postScript","summary":"Create a Script resource.","description":"\nCreates a new script resource. Scripts are organised by directories, of which there are 3, projectName, moduleName, scriptName. Within this structure an indivdual script has a scriptId that is unique. It is possible to have multiple scripts under a given ``projectName/moduleName/scriptName`` structure. Therefore repeated calls to this endpoint will create multiple scripts. Use script update (PUT) to update an existing script (with its unique scriptId)\n\nA script's default version is v0. You can create multiple versions of one scriptId, which is handy in cases of multilingual coverage, targeted content etc. To create another version of a script use the PUT method.\n\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scriptText"],"properties":{"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptText":{"type":"string"}}}}}},"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"orgId":{"type":"string"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptId":{"type":"string"},"scriptText":{"type":"string"},"metadata":{"type":"object","properties":{}},"creationDate":{"type":"string"},"lang":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"soundSegment":{"type":"string"},"atmosphere":{"type":"string"},"contentType":{"type":"string"},"content":{"type":"string"},"placeholders":{"type":"object","properties":{}},"subSections":{"type":"array"},"uuid":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script created","warnings":[],"data":{"orgId":"******************","projectName":"untitled","moduleName":"untitled","scriptName":"untitled","scriptId":"db4d4219-54ca-4f30-8c94-c562e3743743","scriptText":"<as:section name=\"intro\" soundsegment=\"intro\">         hello this is the new script syntax     </as:section>    <as:section name=\"main\" soundsegment=\"main\">         This uses regular H T M L syntax and replaces our old script formatting     </as:section>    <as:section name=\"outro\" soundsegment=\"outro\">         This massively improves usability, aids with learnability and should improve adoption     </as:section>","metadata":{},"creationDate":"2024-12-03T16:07:40.942717","lang":"en","sections":[{"name":"intro","soundSegment":"intro","atmosphere":"","contentType":"tts","content":"hello this is the new script syntax","placeholders":{},"parent":null,"subSections":[],"uuid":"3b504d63-474e-4f00-922b-64971649dbc7"},{"name":"main","soundSegment":"main","atmosphere":"","contentType":"tts","content":"This uses regular H T M L syntax and replaces our old script formatting","placeholders":{},"parent":null,"subSections":[],"uuid":"fe9e7d74-2a84-456c-b75d-c0eb9acfbd21"},{"name":"outro","soundSegment":"outro","atmosphere":"","contentType":"tts","content":"This massively improves usability, aids with learnability and should improve adoption","placeholders":{},"parent":null,"subSections":[],"uuid":"8a162a36-0def-4618-a27a-0179188a692c"}]}}}}}},"400":{"description":"Script could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to parse script","warnings":[],"errors":["empty body"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}},"put":{"tags":["Script"],"operationId":"putScript","summary":"Updates a Script resource.","description":"\nUpdates an existing script resource. Additional versions can be appended to a given scriptId. To do this supply the version field with a named version. For example, `en` or `es`. By default `v0` is reserved and represents the fist version created when the original script was created with a (POST) request.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scriptId","scriptText"],"properties":{"scriptId":{"type":"string","description":"The scriptId of the resource to be updated."},"scriptText":{"type":"string","description":"Script text to replace, or add to new version"},"version":{"type":"string","description":"By default this will update v0, however you can set this field to update/create an additional version of this scriptId"}}}}}},"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"orgId":{"type":"string"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptId":{"type":"string"},"scriptText":{"type":"string"},"metadata":{"type":"object","properties":{}},"creationDate":{"type":"string"},"lang":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"soundSegment":{"type":"string"},"atmosphere":{"type":"string"},"contentType":{"type":"string"},"content":{"type":"string"},"placeholders":{"type":"object","properties":{}},"subSections":{"type":"array"},"uuid":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script updated","warnings":[],"data":{"orgId":"******************","projectName":"untitled","moduleName":"untitled","scriptName":"untitled","scriptId":"1acdadad-a7f9-4082-95fe-cc08c51b35be","scriptText":"<as:section name=\"intro\" soundsegment=\"intro\">         hello this is the new script syntax     </as:section>    <as:section name=\"main\" soundsegment=\"main\">         This uses regular H T M L syntax and replaces our old script formatting     </as:section>    <as:section name=\"outro\" soundsegment=\"outro\">         This massively improves usability, aids with learnability and should improve adoption     </as:section>","metadata":{},"creationDate":"2024-12-03T16:07:41.946390","lang":"en","sections":[{"name":"intro","soundSegment":"intro","atmosphere":"","contentType":"tts","content":"hello this is the new script syntax","placeholders":{},"parent":null,"subSections":[],"uuid":"0b0f5a57-4189-4caf-8a90-7833053a97aa"},{"name":"main","soundSegment":"main","atmosphere":"","contentType":"tts","content":"This uses regular H T M L syntax and replaces our old script formatting","placeholders":{},"parent":null,"subSections":[],"uuid":"8f9a0e37-4e49-41da-96e8-8c4f9f627fea"},{"name":"outro","soundSegment":"outro","atmosphere":"","contentType":"tts","content":"This massively improves usability, aids with learnability and should improve adoption","placeholders":{},"parent":null,"subSections":[],"uuid":"1a94dba3-e000-4984-9a69-19ff398afb04"}]}}}}}},"400":{"description":"Script could not be updated, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to parse script","warnings":[],"errors":["empty body"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"ScriptId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"scriptId not found","warnings":[],"errors":[""]}}}}}}}},"/content/scripts":{"description":"\n## Script Management Description\n\nScripts should be organised into a `projectName/moduleName/scriptName` structure. There are then two methods that are useful for managing content within this structure. These are `/scripts (GET)`, `/scripts (DELETE)`, both of these methods use the same query parameters that allow scripts to either be listed or deleted by given structure. For example, you could list all scripts within a given project, or delete all scripts within a given project and module structure.\n","get":{"tags":["Script"],"operationId":"listScripts","summary":"Lists multiple script resources.","description":"\nList all of the scripts stored. By supplying a project name or module name, you can return a list of all of the scripts stored within the given project or module. \n\nA maximum of 1000 scripts can be returned in a single GET request, a `paginationToken` will be returned that can be passed to the same method again to list the next 1000 scripts.\n\nTo condense the output JSON, you can supply `verbose=False`, which will remove all of the non-essential details. Leaving only the script directory structure and ID in the response.\n","parameters":[{"in":"query","name":"projectName","schema":{"type":"string"}},{"in":"query","name":"moduleName","schema":{"type":"string"}},{"in":"query","name":"scriptName","schema":{"type":"string"}},{"in":"query","name":"scriptId","schema":{"type":"string"}},{"in":"query","name":"paginationToken","schema":{"type":"string"}},{"in":"query","name":"verbose","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"scripts":{"type":"array","items":{"type":"object","properties":{"orgId":{"type":"string"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptId":{"type":"string"},"scriptText":{"type":"string"},"metadata":{"type":"object","properties":{}},"creationDate":{"type":"string"},"lang":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"atmosphere":{"type":"string"},"parent":{"type":"string"},"subSections":{"type":"array"},"soundSegment":{"type":"string"},"name":{"type":"string"},"placeholders":{"type":"object","properties":{}},"contentType":{"type":"string"},"uuid":{"type":"string"},"content":{"type":"string"}}}}}}},"nextToken":{"type":"string"}}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/content/script/{scriptId}":{"get":{"tags":["Script"],"operationId":"getScriptId","summary":"Get a single script.","parameters":[{"in":"path","name":"scriptId","required":true,"schema":{"type":"string"}},{"in":"query","name":"preview","required":false,"description":"Preview the effect of applying various text correction processes, normalisation and dictionary.","schema":{"type":"string"}},{"in":"query","name":"voice","required":false,"description":"Which TTS voice should be used to generate the preview, note that this required as different voices require different text correction processes.","schema":{"type":"string"}}],"responses":{"200":{"description":"Script returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"orgId":{"type":"string"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptId":{"type":"string"},"scriptText":{"type":"string"},"metadata":{"type":"object","properties":{}},"creationDate":{"type":"string"},"lang":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"atmosphere":{"type":"string"},"subSections":{"type":"array"},"soundSegment":{"type":"string"},"name":{"type":"string"},"placeholders":{"type":"object","properties":{}},"contentType":{"type":"string"},"uuid":{"type":"string"},"content":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script created","warnings":[],"data":{"orgId":"******************","projectName":"untitled","moduleName":"untitled","scriptName":"untitled","scriptId":"c59b7ec3-6773-412d-bd09-cfc756726e6f","scriptText":"<as:section name=\"default\">hello</as:section>","metadata":{},"creationDate":"2024-12-03T16:07:46.508702","lang":"fi","sections":[{"atmosphere":"","parent":null,"subSections":[],"soundSegment":"","name":"default","placeholders":{},"contentType":"tts","uuid":"adc51d65-9f07-4507-bfa9-c2272487751e","content":"hello"}]}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"ScriptId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"scriptId not found","warnings":[],"errors":[""]}}}}}}},"delete":{"tags":["Script"],"operationId":"deleteScriptId","summary":"Deletes a script and all its versions (if applicable).","parameters":[{"in":"path","name":"scriptId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Script deleted","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script deleted","warnings":[],"data":{}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/content/script/{scriptId}/{version}":{"get":{"tags":["Script"],"operationId":"getScriptVersion","summary":"Get a single version of a script with a given scriptId.","parameters":[{"in":"path","name":"scriptId","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}},{"in":"query","name":"preview","required":false,"description":"Preview the effect of applying various text correction processes, normalisation and dictionary.","schema":{"type":"string"}},{"in":"query","name":"voice","required":false,"description":"Which TTS voice should be used to generate the preview, note that this required as different voices require different text correction processes.","schema":{"type":"string"}}],"responses":{"200":{"description":"Script returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"orgId":{"type":"string"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"scriptId":{"type":"string"},"scriptText":{"type":"string"},"metadata":{"type":"object","properties":{}},"creationDate":{"type":"string"},"lang":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"atmosphere":{"type":"string"},"subSections":{"type":"array"},"soundSegment":{"type":"string"},"name":{"type":"string"},"placeholders":{"type":"object","properties":{}},"contentType":{"type":"string"},"uuid":{"type":"string"},"content":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script created","warnings":[],"data":{"orgId":"******************","projectName":"untitled","moduleName":"untitled","scriptName":"untitled","scriptId":"c74d0f71-99a9-46f1-a299-500d63e3625b","scriptText":"<as:section name=\"default\">hello</as:section>","metadata":{},"creationDate":"2024-12-03T16:07:48.503795","lang":"fi","sections":[{"atmosphere":"","parent":null,"subSections":[],"soundSegment":"","name":"default","placeholders":{},"contentType":"tts","uuid":"5f6e1d6f-654a-45e3-98c0-8904757dab45","content":"hello"}]}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"ScriptId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"scriptId not found","warnings":[],"errors":[""]}}}}}}},"delete":{"tags":["Script"],"operationId":"deleteScriptVersion","summary":"Deletes a single version of a script.","parameters":[{"in":"path","name":"scriptId","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Script deleted","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"script deleted","warnings":[],"data":{}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/content/list_projects":{"get":{"tags":["Script"],"operationId":"listScriptProjects","summary":"Lists all projects that have been created.","parameters":[],"responses":{"200":{"description":"Projects returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"projects":{"type":"array","items":{"type":"object","properties":{"pk":{"type":"string"},"sk":{"type":"string"}}}}}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}}}}},"/content/generate/advert":{"post":{"tags":["Script"],"operationId":"generateAdvert","summary":"Generate an advert using AI based on a Productdescription.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["productName","productDescription"],"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"},"mood":{"type":"string"},"tone":{"type":"string"},"thirdPerson":{"type":"boolean"},"adLength":{"type":"number"}}}}}},"responses":{"201":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"adName":{"type":"string"},"adText":{"type":"string"},"scriptId":{"type":"string"},"adType":{"type":"string"},"mood":{"type":"string"},"tone":{"type":"string"},"gender":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"advert created","warnings":[],"data":{"adName":"Yoto: Imagination Unleashed","adText":"Albert Einstein once said, 'Imagination is more important than knowledge.' Yoto brings this imagination to life with an innovative audio player for kids, offering a screen-free experience with stories and music. Designed for little ones, Yoto lets children engage with physical cards unlocking endless adventures and educational content. Let your child's creativity soar! Visit yotoplayer.com today and discover the magic of play without screens.","scriptId":"66e8fb9a-86b0-4353-a581-9ce66461ade6","adType":"","mood":"happy","tone":"flat","gender":"male","tags":["Audio Player","Kids Entertainment","Screen-Free Experience"]}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"422":{"description":"Invalid adLength","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to generate advert!","warnings":[],"errors":["Invalid adLength. Available values for adLength are: 10 15 20 30 40!"]}}}}}}}},"/content/edit/advert":{"post":{"tags":["Script"],"operationId":"editAdvert","summary":"Edit an advert.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["productName","adText","instruction"],"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"},"adText":{"type":"string"},"voice":{"type":"string"},"soundTemplate":{"type":"string"},"instruction":{"type":"string"},"adLength":{"type":"number"},"filters":{"type":"object","properties":{"accent":{"type":"array","items":{"enum":["in","indian","jp","japanese","cn","chinese","ca","canadian","tw","taiwanese","au","australian","rs","serbian","us","american","unknown","nl","dutch","shaanxi","gb","british","guangxi","china","sk","slovak","no","norwegian","xx","lb","lebanese","id","indonesian","vn","vietnamese","ph","filipino","ba","bosnian and herzegovinian","tn","tunisian","de","za","south african","pa","panamanian","it","italian","br","brazilian","ro","romanian","german","es","spanish","ua","ukrainian","pl","polish","ee","estonian","af","afghan","pt","portuguese","multilingual","hk","hong kong","mx","mexican","sichuan","ie","irish","se","swedish","fr","french","uy","uruguayan","al","albanian","ch","swiss","ge","georgian","gt","guatemalan","my","malaysian","pr","puerto rican","ru","russian","tr","turkish","th","thai","bg","bulgarian","dk","danish","kr","south korean","la","laotian","ae","emirati","pk","pakistani","be","belgian","gr","greek","om","omani","shandong","mt","maltese","sv","salvadoran","il","israeli","np","nepalese","mn","mongolian","sg","singaporean","lk","sri lankan","ve","venezuelan","kh","cambodian","hu","hungarian","ke","kenyan","co","colombian","english","ar","argentinian","am","armenian","at","austrian","cl","chilean","ye","yemeni","ng","nigerian","great britain","xa","arabic","hn","honduran","mm","burmese","ec","ecuadorian","ir","iranian","great british","is","icelandic","sa","saudi arabian","liaoning","cz","czech","tz","tanzanian","canada","fi","finnish","france","lv","latvian","none","lt","lithuanian","ma","moroccan","et","ethiopian","mk","macedonian","eg","egyptian","do","dominican","ly","libyan","kw","kuwaiti","so","somali","bh","bahraini","brazil","si","slovenian","cr","costa rican","kz","kazakhstani","uz","uzbekistani","dz","algerian","bo","bolivian","az","azerbaijani","gq","equatorial guinean","ni","nicaraguan","iq","iraqi","nz","new zealand","py","paraguayan","qa","qatari"],"type":"string"},"uniqueItems":true},"gender":{"type":"array","items":{"enum":["male","female","character","unknown"],"type":"string"},"uniqueItems":true},"ageBracket":{"type":"array","items":{"enum":["adult","child","senior"],"type":"string"},"uniqueItems":true},"provider":{"type":"array","items":{"enum":["google","polly","azure","elevenlabs","ibm","wellsaid","playht","cerevoice","deepzen","retro","resemble","openai","msnr","voice_engine_3","voice_engine_2","voice_engine_1"],"type":"string"},"uniqueItems":true}},"required":["language"]}}}}}},"responses":{"201":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"adText":{"type":"string"},"scriptId":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"voice":{"type":"object","properties":{}},"soundTemplate":{"type":"object","properties":{}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"advert created","warnings":[],"data":{"adText":"Experience the power of AWS Lambda with Firecracker technology! Enjoy secure, fast microVMs for serverless computing and container workloads. Efficiency redefined! Embrace the future of virtualization today!","scriptId":"204ff952-0d37-49ab-a437-bf1613b383c3","tags":["AWS Lambda","Firecracker","technology","virtualization"],"voice":{},"soundTemplate":{}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"422":{"description":"Invalid Json or required keys not present","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to generate advert!","warnings":[],"errors":["invalid json in body"]}}}}}}}},"/speech/tts":{"description":"\n## Product Description\n\nOur Text-to-speech provides harmonious access to more than 8 external TTS providers. Our single interface ensures no matter the provider your script content will be synthesized to the highest quality. We have a number of text inteligence services that you can use to improve and humanise synthetic voices, these are located in the `speech/lexi` endpoints. \n\n","post":{"tags":["Speech"],"operationId":"postSpeech","summary":"Create a text-to-speech resource.","description":"\nTo create speech you need to supply the scriptId of the script you wish to generate, and the voice you would like to generate this request.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"scriptId":{"type":"string","description":"Reference to the Script that is to be synthesized, use `/script` to create and get it."},"voice":{"type":"string","default":"Joanna","description":"Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/"},"speed":{"type":"number","format":"float","default":1,"description":"Scalar for speed manipulation, range 0.5-3."},"silencePadding":{"type":"string","description":"Amount of microseconds for silence padding. Half of the amount is inserted as silence at the beginning and at the end of each Speech file."},"audience":{"type":"object","description":"\nObject defining the values for Script parameters. E.g. for Script parameters in:\n\n```xml\n<as:section name=\"main\"> \n    Hello <as:placeholder id=\"username\"> </as:placeholder>\n    how's your <as:placeholder id=\"weekday\"> </as:placeholder>\n</as:section>\n```\nThe object would be `{\"username\": \"Michael\", \"weekday\": \"Sunday\"}`.\n"},"sections":{"type":"object","description":"Separate configurations for Script section. E.g. to specify a separate voice and speed for Script section `intro` the object would be `{\"intro\": {\"voice\": \"Leah\", \"speed\": 1.2}}`.\n"},"voiceIntelligence":{"type":"boolean","description":"Flag to apply lexicographical text corrections"},"public":{"type":"boolean","description":"Makes returned URLs publicly available"},"useDenoiser":{"type":"boolean","description":"Flag to apply denoiser"},"useAutofix":{"type":"boolean","description":"Flag to apply autofix"}},"required":["scriptId"]}}}},"responses":{"201":{"description":"Text-to-speech created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Text-to-speech created","warnings":[],"data":{"speechId":"977ac6f6-aa87-4e61-8383-14f749a6461d","scriptId":"8cf9cd32-5f30-45d5-951d-48e9754d8d6f","scriptMetadata":{},"creationDate":1733242099,"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","chargeForVoiceIntelligence":false,"sections":[{"sectionName":"main","statusCode":"201","message":"Synthesis successful.","audience":{},"url":"******************","preview":"This uses regular H T M L syntax and replaces our ...","voice":"joanna","speed":1,"length":[5.041632653],"sectionId":"7ba50698-4d44-4039-b4a5-81e558139dbb","file":"7ba50698-4d44-4039-b4a5-81e558139dbb.wav"},{"sectionName":"outro","statusCode":"201","message":"Synthesis successful.","audience":{},"url":"******************","preview":"This massively improves usability, aids with learn...","voice":"joanna","speed":1,"length":[5.12],"sectionId":"b6f604f0-6336-44b8-80cb-efba95b172ca","file":"b6f604f0-6336-44b8-80cb-efba95b172ca.wav"},{"sectionName":"intro","statusCode":"201","message":"Synthesis successful.","audience":{},"url":"******************","preview":"hello this is the new script syntax","voice":"joanna","speed":1,"length":[2.351020408],"sectionId":"80931c5c-a214-4ee0-b01d-4784ef702148","file":"80931c5c-a214-4ee0-b01d-4784ef702148.wav"}]}}}}}},"202":{"description":"Text-to-speech in progress","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}}}}}},"400":{"description":"Text-to-speech could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create tts","warnings":[],"errors":["empty body"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Voice or scriptId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"speech request failed to validate","warnings":[],"errors":["scriptId noparrotlove not found."]}}}}}}},"get":{"tags":["Speech"],"operationId":"listTTS","summary":"Lists multiple text-to-speech resources.","description":"\nReturns a list of speech files that have been created. Can be filtered by `projectName`, `moduleName`, `scriptName` and `scriptId`.\n","parameters":[{"in":"query","name":"projectName","schema":{"type":"string"}},{"in":"query","name":"moduleName","schema":{"type":"string"}},{"in":"query","name":"scriptName","schema":{"type":"string"}},{"in":"query","name":"scriptId","schema":{"type":"string"}},{"in":"query","name":"paginationToken","schema":{"type":"string"}},{"in":"query","name":"verbose","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Script created/updated successfully.","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechIds":{"type":"array"}}}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"405":{"description":"Query parameters not configured","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to list text-to-speech files","warnings":[],"errors":["ProjectName needs to be supplied to filter by moduleName."]}}}}}}}},"/speech/tts/section":{"post":{"tags":["Speech"],"operationId":"postSpeechSection","summary":"Create a single section of a text-to-speech resource.","description":"\nTo create speech you need to supply the scriptId of the script you wish to generate, and the voice you would like to generate this request.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"scriptId":{"type":"string","description":"Reference to the Script that is to be synthesized, use `/script` to create and get it."},"voice":{"type":"string","default":"Joanna","description":"Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/"},"speed":{"type":"number","format":"float","default":1,"description":"Scalar for speed manipulation, range 0.5-3."},"silencePadding":{"type":"string","description":"Amount of microseconds for silence padding. Half of the amount is inserted as silence at the beginning and at the end of each Speech file."},"audience":{"type":"object","description":"\nObject defining the values for Script parameters. E.g. for Script parameters in:\n\n```xml\n<as:section name=\"main\"> \n    Hello <as:placeholder id=\"username\"> </as:placeholder>\n    how's your <as:placeholder id=\"weekday\"> </as:placeholder>\n</as:section>\n```\nThe object would be `{\"username\": \"Michael\", \"weekday\": \"Sunday\"}`.\n"},"sections":{"type":"object","description":"Separate configurations for Script section. E.g. to specify a separate voice and speed for Script section `intro` the object would be `{\"intro\": {\"voice\": \"Leah\", \"speed\": 1.2}}`.\n","properties":{"voice":{"type":"string","description":"voice for named section"},"speed":{"type":"number","format":"float","description":"speed for named section"},"maxLength":{"type":"number","format":"float","description":"max length for named section, resultant audio will be transform if length exceeds target"}}},"voiceIntelligence":{"type":"boolean","description":"Flag to apply lexicographical text corrections"},"public":{"type":"boolean","description":"Makes returned URLs publicly available"},"sectionToProduce":{"type":"string","description":"The name of the script section to produce"}},"required":["scriptId","sectionToProduce"]}}}},"responses":{"201":{"description":"Text-to-speech created","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Text-to-speech created","warnings":[],"data":{"speechId":"a3ebb711-b43e-419d-8b04-83d1f309bc8c","scriptId":"6318e2b8-cb89-4046-9514-fd52f7285d77","scriptMetadata":{},"creationDate":1733242107,"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","chargeForVoiceIntelligence":false,"sections":[{"sectionName":"intro","statusCode":"201","message":"Synthesis successful.","audience":{},"url":"******************","preview":"hello this is the new script syntax","voice":"joanna","speed":1,"length":[2.351020408],"sectionId":"6c090834-b160-4d8c-87cb-7af2ce0634b0","file":"6c090834-b160-4d8c-87cb-7af2ce0634b0.wav"}]}}}}}},"400":{"description":"Text-to-speech could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create tts","warnings":[],"errors":["empty body"]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Voice or scriptId not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"speech request failed to validate","warnings":[],"errors":["scriptId noparrotlove not found."]}}}}}}}},"/speech/tts/preview":{"post":{"tags":["Speech"],"operationId":"postSpeechPreview","summary":"Create a fast preview of a given voice","description":" This route is limited to 6MB of audio response. The response is base64 encoded audio/mpeg bytes. Please be aware if the response size exceeds 6mb we return a URL in the response body.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"text":{"type":"string","description":"Text to synthesize."},"voice":{"type":"string","default":"Joanna","description":"Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/"}},"required":["voice","properties"]}}}},"responses":{"200":{"description":"Text-to-speech created","content":{"application/json":{"schema":{"properties":{},"example":{}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"422":{"description":"Text-to-speech could not be created, see errors","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to create preview","warnings":[],"errors":["2 validation errors for TTSPreview\nvoice\n  Field required [type=missing, input_value={'accept_header': 'audio/mp3'}, input_type=dict]\n    For further information visit https://errors.pydantic.dev/2.9/v/missing\ntext\n  Field required [type=missing, input_value={'accept_header': 'audio/mp3'}, input_type=dict]\n    For further information visit https://errors.pydantic.dev/2.9/v/missing"]}}}}}}}},"/speech/tts/{speechId}":{"get":{"tags":["Speech"],"operationId":"getSpeechId","summary":"Retrieve a text-to-speech resource.","parameters":[{"in":"path","name":"speechId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Text-to-speech returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Text-to-speech created","warnings":[],"data":{"speechId":"f815eb77-0195-4afd-bb22-e2a33449b54f","scriptId":"2b298afd-dd82-4688-94aa-ebc8c6c705d9","scriptMetadata":{},"creationDate":1733242111,"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","chargeForVoiceIntelligence":false,"sections":[{"sectionName":"default","statusCode":"201","message":"Synthesis successful.","audience":{},"url":"******************","preview":"This is our first section of our script.","voice":"joanna","speed":1,"length":[2.089795918],"sectionId":"516540bf-1fa8-422b-a856-3de984c471a1","file":"516540bf-1fa8-422b-a856-3de984c471a1.wav"}]}}}}}},"202":{"description":"Text-to-speech still in progress","content":{"application/json":{"schema":{"properties":{},"example":{}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Text-to-speech not returned","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to get text-to-speech item","warnings":[],"errors":["speechId not found"]}}}}}}},"delete":{"tags":["Speech"],"operationId":"deleteSpeechId","summary":"Deletes a text-to-speech resource","parameters":[{"in":"path","name":"speechId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text-to-speech deleted","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"removed","warnings":[],"data":{}}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"404":{"description":"Text-to-speech not deleted","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"removed","warnings":[],"data":{}}}}}}}}},"/speech/tts/reduce":{"post":{"tags":["Speech"],"operationId":"postReduce","summary":"Reduce length of speech to fit in a target using silence removal and time stretching with pitch preservation.","description":"","requestBody":{"description":"Specify target length in seconds, supports float and int types","required":true,"content":{"application/json":{"schema":{"properties":{"speechId":{"type":"string","description":"speech id to reduce."},"targetLength":{"type":"number","format":"float","description":"Target length for duration of speech"}},"required":["speechId","targetLength"]}}}},"responses":{"200":{"description":"Text-to-speech reduced","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Success. Stretched speechId and files listed below","warnings":[],"data":{"speechId":"d62e58da-fc5d-4da2-acd3-87a1b41b7f8d","scriptId":"60a8fd6a-fc22-44ac-aaed-2b22e1b9eeab","scriptMetadata":{},"creationDate":1733242124,"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","chargeForVoiceIntelligence":false,"sections":[{"sectionName":"intro","statusCode":"201","message":"Speech length reduced to 5.0 s.","audience":{},"url":"******************","preview":"hello this is a test file for reduce, let's speed ...","voice":"joanna","speed":1,"length":[4.994807256],"sectionId":"9ea78f90-1782-454e-b6ff-ed853faca211","file":"9ea78f90-1782-454e-b6ff-ed853faca211.wav"}]}}}}}},"400":{"description":"Text-to-speech reduced","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to process audio","warnings":[],"errors":["Check supplied arguments are in range."]}}}}}}}},"/speech/tts/remove_padding":{"post":{"tags":["Speech"],"operationId":"postRemoveSilence","summary":"Remove silence of a file given the parameters below.","description":"","requestBody":{"description":"Specify parameters and speechId and remove its padding silence","required":true,"content":{"application/json":{"schema":{"type":"object","required":["speechId"],"properties":{"speechId":{"type":"string","description":"speech id to remove padding from."},"minSilenceDuration":{"type":"number","format":"float","description":"How long a silent region must be to be considered removable silence. Default is 0.01"},"silenceThreshold":{"type":"number","format":"float","description":"Amplitude threshold in % below which audio will be considered silence. Default is 0.1"},"position":{"type":"string","description":"Where to remove silence 'end', 'start' or 'all' for all across the file. Default is 'end'"}}}}}},"responses":{"200":{"description":"Text-to-speech silence padding removed","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"data":{"type":"object","properties":{"speechId":{"type":"string"},"scriptId":{"type":"string"},"scriptMetadata":{"type":"object","properties":{}},"creationDate":{"type":"integer"},"projectName":{"type":"string"},"moduleName":{"type":"string"},"scriptName":{"type":"string"},"chargeForVoiceIntelligence":{"type":"integer"},"sections":{"type":"array","items":{"type":"object","properties":{"sectionName":{"type":"string"},"statusCode":{"type":"string"},"message":{"type":"string"},"audience":{"type":"object","properties":{}},"url":{"type":"string"},"preview":{"type":"string"},"voice":{"type":"string"},"speed":{"type":"integer"},"length":{"type":"array","items":{"type":"number"}},"sectionId":{"type":"string"},"file":{"type":"string"}}}}}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Success. Stretched speechId and files listed below","warnings":[],"data":{"speechId":"f710a287-4eb2-49cd-bcfa-2184af0f057a","scriptId":"5051efea-1eea-4080-85ab-90065824abe1","scriptMetadata":{},"creationDate":1733242133,"projectName":"untitled","moduleName":"untitled","scriptName":"untitled","chargeForVoiceIntelligence":false,"sections":[{"sectionName":"intro","statusCode":"201","message":"Speech padding removed.","audience":{},"url":"******************","preview":"This is an example to demonstrate how to remove pa...","voice":"joanna","speed":1,"length":[7.014036281],"sectionId":"e2b9afe6-adaa-4a5f-8409-002a2dd98611","file":"e2b9afe6-adaa-4a5f-8409-002a2dd98611.wav"}]}}}}}},"404":{"description":"Speech id not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"speechId not supplied","warnings":[],"errors":["speechId not supplied"]}}}}}}}},"/speech/tts/annotate":{"post":{"tags":["Speech"],"operationId":"annotate","summary":"Returns time annotations for each word.","description":"\nReturns timestamps, or time in seconds, when each word is spoken for a given generated speech file. You only need to provide a SpeechID in order to receive an annotation of the relevant time annotations.\n","requestBody":{"description":"Get a list of words and its time annotations, either timestamps or seconds","required":true,"content":{"application/json":{"schema":{"type":"object","required":["speechId"],"properties":{"speechId":{"type":"string","description":"Speech ID for the speech file you want to annotate."},"languageCode":{"type":"string","description":"languageCode (ISO 639-1 standard) of the speech file. If not provided, we try to detect the language."}}}}}},"responses":{"404":{"description":"Text-to-speech not found","content":{"application/json":{"schema":{"properties":{"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"},"errors":{"type":"array","items":{"type":"string"}}},"example":{"meta":{"version":"123","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to get text-to-speech item","warnings":[],"errors":["speechId not found"]}}}}}}}},"/speech/sts/voices":{"get":{"tags":["Speech"],"operationId":"getspeechtospeechvoices","summary":"List available speech-to-speech compatible voices.","description":"\n## List STS compatible voices\n\nThis endpoint returns the list of voices which you can use with STS - including any private voices for which you have permissions.\n","responses":{"200":{"description":"Successfully retrieved speech-to-speech compatible voices.","content":{"application/json":{"schema":{"properties":{"data":{"type":"array"},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":[],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"STS compatible voices returned","warnings":[]}}}}},"403":{"description":"Invalid API key.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}},"/speech/sts":{"post":{"tags":["Speech"],"operationId":"postspeechtospeech","summary":"Submit a voice recording for speech-to-speech transformation into a different speaker.","description":"\n## Post new STS pipeline\n\nThis endpoint allows the user to initiate an STS pipeline to transform their source recording. This pipeline runs asynchronously and creates a new file in your Content area.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fileId","alias"],"properties":{"fileId":{"type":"string","title":"File ID","description":"File ID of the voice recording you want to run through STS."},"alias":{"type":"string","title":"Alias of voice to apply to input recording.","description":"This is the voice you want the output to sound like. You can get a list of available voices from `/speech/sts/voices` and you can listen to samples in our voice library (https://platform.audiostack.ai/workflows/voice-library)."},"newFilePath":{"type":"string","title":"New File Path","description":"The path and name of the new file to be created in your Content area (https://platform.audiostack.ai/content).","example":"path/to/my_sts_output.wav"}}}}}},"responses":{"202":{"description":"Successful submission of speech-to-speech job.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"pipelineId":{"type":"string"}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"pipelineId":"88cccb7f-3e2e-4872-ae48-e34f801fa654"},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Pipeline started and pipelineId returned","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"403":{"description":"Invalid API key.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}},"422":{"description":"Valid alias but not supported for STS.","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"number"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":["Voice Error"],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Voice alias goblin does not support STS.","warnings":[]}}}}}}}},"/speech/sts/{pipelineId}":{"get":{"tags":["Speech"],"operationId":"getspeechtospeechpipeline","description":"\n\n## Get status of STS pipeline status\n\nThis endpoint fetches the current status of your STS pipeline.\n","summary":"Get speech-to-speech generation pipeline status updates.","parameters":[{"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get request successful and status of speech-to-speech pipeline retrieved.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"},"metadata":{"type":"object","properties":{}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"status":202,"dateCreated":1733242173,"pipelineId":"80eb7f41-2a58-484a-867b-9dcad2a5fb03","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[],"metadata":{}},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Pipeline status returned: pipeline still running","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"202":{"description":"Get request successful and status of speech-to-speech in progress.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"status":{"type":"integer"},"dateCreated":{"type":"integer"},"pipelineId":{"type":"string"},"results":{"type":"object","properties":{"replacedFileIds":{"type":"array"},"newFileIds":{"type":"array"},"inputFileIds":{"type":"array"},"data":{"type":"object","properties":{}}}},"message":{"type":"string"},"errors":{"type":"array"},"metadata":{"type":"object","properties":{}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}},"example":{"data":{"status":202,"dateCreated":1733242173,"pipelineId":"80eb7f41-2a58-484a-867b-9dcad2a5fb03","results":{"replacedFileIds":[],"newFileIds":[],"inputFileIds":[],"data":{}},"message":"","errors":[],"metadata":{}},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Pipeline status returned: pipeline still running","warnings":["Indicated billing is lower then the actual value, which will be calculated once your request is finished."]}}}}},"403":{"description":"Invalid API key.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Missing authentication token. There might be no such route or method."}}}}},"404":{"description":"Get request successful but not pipelineId not found.","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array"},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"errors":[],"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Failed to find pipeline","warnings":[]}}}}}}}},"/production/sound/atmosphere":{"get":{"tags":["Sound Atmospheres"],"operationId":"getAtmosphere","summary":"Lists available sound atmospheres.","description":"\n\nLists all of the available sound templates that can be used in your audio project.\n\n","responses":{"200":{"description":"Atmospheres listed","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"atmospheres":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"samples":{"type":"object","properties":{}},"durations":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"increments":{"type":"integer"},"fixedValues":{"type":"array","items":{"type":"number"}}}},"license_type":{"type":"string"},"segmentNames":{"type":"array","items":{"type":"string"}},"accessType":{"type":"string"},"soundAtmosId":{"type":"string"},"atmosGeneration":{"type":"object","properties":{"type":{"type":"string"}}}}}}}},"meta":{"type":"object","properties":{"version":{"type":"string"},"requestId":{"type":"string"},"creditsUsed":{"type":"integer"},"creditsRemaining":{"type":"number"}}},"message":{"type":"string"},"warnings":{"type":"array"}},"example":{"data":{"atmospheres":[{"name":"train arrival","alias":"train_arrival","samples":{},"layers":null,"tags":null,"durations":{"min":21.00183106575964,"max":21.00183106575964,"increments":0,"fixedValues":[21.00183106575964]},"license_type":"standard","segmentNames":["train_arrival.wav"],"accessType":"public","soundAtmosId":"5afd23eb-ce7e-411c-8be7-81d4006d7424","atmosGeneration":{"type":"static"}},{"name":"city ambience","alias":"city_ambience","samples":{},"layers":null,"tags":null,"durations":{"min":18.26983560090703,"max":18.26983560090703,"increments":0,"fixedValues":[18.26983560090703]},"license_type":"standard","segmentNames":["city_ambience.wav"],"accessType":"public","soundAtmosId":"8d8e4cb8-f153-4d77-8582-0de93176d8a3","atmosGeneration":{"type":"static"}},{"name":"tennis match","alias":"tennis_match","samples":{},"layers":null,"tags":null,"durations":{"min":14.001831065759637,"max":14.001831065759637,"increments":0,"fixedValues":[14.001831065759637]},"license_type":"standard","segmentNames":["tennis_match.wav"],"accessType":"public","soundAtmosId":"dbe89f9b-64fc-4648-8972-feac23cdd273","atmosGeneration":{"type":"static"}},{"name":"train underground","alias":"train_underground","samples":{},"layers":null,"tags":null,"durations":{"min":33.00183106575964,"max":33.00183106575964,"increments":0,"fixedValues":[33.00183106575964]},"license_type":"standard","segmentNames":["train_underground.wav"],"accessType":"public","soundAtmosId":"e5fa0a04-e470-4220-8407-435741b9311d","atmosGeneration":{"type":"static"}},{"name":"aeroplane take off","alias":"aeroplane_take_off","samples":{},"layers":null,"tags":null,"durations":{"min":15.001831065759637,"max":15.001831065759637,"increments":0,"fixedValues":[15.001831065759637]},"license_type":"standard","segmentNames":["aeroplane_take_off.wav"],"accessType":"public","soundAtmosId":"4bad0a72-9ae4-4855-a36b-b9667f4fa3de","atmosGeneration":{"type":"static"}},{"name":"train station indoors","alias":"train_station_indoors","samples":{},"layers":null,"tags":null,"durations":{"min":63.54618480725624,"max":63.54618480725624,"increments":0,"fixedValues":[63.54618480725624]},"license_type":"standard","segmentNames":["train_station_indoors.wav"],"accessType":"public","soundAtmosId":"a1d15af8-030c-4077-8ca4-4509b55bfa4d","atmosGeneration":{"type":"static"}},{"name":"train announcement","alias":"train_announcement","samples":{},"layers":null,"tags":null,"durations":{"min":11.501831065759637,"max":11.501831065759637,"increments":0,"fixedValues":[11.501831065759637]},"license_type":"standard","segmentNames":["train_announcement.wav"],"accessType":"public","soundAtmosId":"ab55e987-ee8b-45d4-bca5-a44653052a37","atmosGeneration":{"type":"static"}},{"name":"football failed goal","alias":"football_failed_goal","samples":{},"layers":null,"tags":null,"durations":{"min":20.436184807256236,"max":20.436184807256236,"increments":0,"fixedValues":[20.436184807256236]},"license_type":"standard","segmentNames":["football_failed_goal.wav"],"accessType":"public","soundAtmosId":"bee16cbe-1e16-4036-9ffb-492f5e95e89c","atmosGeneration":{"type":"static"}},{"name":"traffic medium","alias":"traffic_medium","samples":{},"layers":null,"tags":null,"durations":{"min":61.00183106575964,"max":61.00183106575964,"increments":0,"fixedValues":[61.00183106575964]},"license_type":"standard","segmentNames":["traffic_medium.wav"],"accessType":"public","soundAtmosId":"6e5c4310-61ad-41cb-b77a-58384be7d79f","atmosGeneration":{"type":"static"}},{"name":"traffic horns","alias":"traffic_horns","samples":{},"layers":null,"tags":null,"durations":{"min":69.00183106575963,"max":69.00183106575963,"increments":0,"fixedValues":[69.00183106575963]},"license_type":"standard","segmentNames":["traffic_horns.wav"],"accessType":"public","soundAtmosId":"a34e915c-3d43-4834-8601-803189c879f8","atmosGeneration":{"type":"static"}},{"name":"football missed goal","alias":"football_missed_goal","samples":{},"layers":null,"tags":null,"durations":{"min":43.79645691609977,"max":43.79645691609977,"increments":0,"fixedValues":[43.79645691609977]},"license_type":"standard","segmentNames":["football_missed_goal.wav"],"accessType":"public","soundAtmosId":"65e1d53e-65d9-4dc7-997f-35ebb217ec71","atmosGeneration":{"type":"static"}},{"name":"train pass by slow","alias":"train_pass_by_slow","samples":{},"layers":null,"tags":null,"durations":{"min":21.00183106575964,"max":21.00183106575964,"increments":0,"fixedValues":[21.00183106575964]},"license_type":"standard","segmentNames":["train_pass_by_slow.wav"],"accessType":"public","soundAtmosId":"d19a3466-a4c0-405c-b4d4-50becb72e365","atmosGeneration":{"type":"static"}},{"name":"boxing training","alias":"boxing_training","samples":{},"layers":null,"tags":null,"durations":{"min":21.00183106575964,"max":21.00183106575964,"increments":0,"fixedValues":[21.00183106575964]},"license_type":"standard","segmentNames":["boxing_training.wav"],"accessType":"public","soundAtmosId":"32df920c-47fe-4345-a2ae-f26b05a9f441","atmosGeneration":{"type":"static"}},{"name":"train indoor ambient","alias":"train_indoor_ambient","samples":{},"layers":null,"tags":null,"durations":{"min":57.00183106575964,"max":57.00183106575964,"increments":0,"fixedValues":[57.00183106575964]},"license_type":"standard","segmentNames":["train_indoor_ambient.wav"],"accessType":"public","soundAtmosId":"30652d05-f347-4ed4-b510-e53e1205d455","atmosGeneration":{"type":"static"}},{"name":"tennis point","alias":"tennis_point","samples":{},"layers":null,"tags":null,"durations":{"min":7.501831065759637,"max":7.501831065759637,"increments":0,"fixedValues":[7.501831065759637]},"license_type":"standard","segmentNames":["tennis_point.wav"],"accessType":"public","soundAtmosId":"8bb4ce31-586c-4880-870b-1cb1ebc2979e","atmosGeneration":{"type":"static"}},{"name":"jungle night","alias":"jungle_night","samples":{},"layers":null,"tags":null,"durations":{"min":86.58214852607709,"max":86.58214852607709,"increments":0,"fixedValues":[86.58214852607709]},"license_type":"standard","segmentNames":["jungle_night.wav"],"accessType":"public","soundAtmosId":"51654a9a-0127-40ab-ac6f-2800e6700fed","atmosGeneration":{"type":"static"}},{"name":"football crowd","alias":"football_crowd","samples":{},"layers":null,"tags":null,"durations":{"min":43.00183106575964,"max":43.00183106575964,"increments":0,"fixedValues":[43.00183106575964]},"license_type":"standard","segmentNames":["football_crowd.wav"],"accessType":"public","soundAtmosId":"72d107b7-c6d9-4c51-bba7-c76ea83b8dba","atmosGeneration":{"type":"static"}},{"name":"school playground","alias":"school_playground","samples":{},"layers":null,"tags":null,"durations":{"min":91.54727324263038,"max":91.54727324263038,"increments":0,"fixedValues":[91.54727324263038]},"license_type":"standard","segmentNames":["school_playground.wav"],"accessType":"public","soundAtmosId":"5cfc3677-3289-412d-83f9-a10a18a81a9a","atmosGeneration":{"type":"static"}},{"name":"train passing by mono","alias":"train_passing_by_mono","samples":{},"layers":null,"tags":null,"durations":{"min":34.28754535147392,"max":34.28754535147392,"increments":0,"fixedValues":[34.28754535147392]},"license_type":"standard","segmentNames":["train_passing_by_mono.wav"],"accessType":"public","soundAtmosId":"5fcfcc8c-f0e3-40f7-881a-195eaf851d6f","atmosGeneration":{"type":"static"}},{"name":"snow walk","alias":"snow_walk","samples":{},"layers":null,"tags":null,"durations":{"min":61.92935941043084,"max":61.92935941043084,"increments":0,"fixedValues":[61.92935941043084]},"license_type":"standard","segmentNames":["snow_walk.wav"],"accessType":"public","soundAtmosId":"d64ebe21-6a1f-43ab-8ca8-56a7a7931eec","atmosGeneration":{"type":"static"}},{"name":"sea waves windy","alias":"sea_waves_windy","samples":{},"layers":null,"tags":null,"durations":{"min":62.6740306122449,"max":62.6740306122449,"increments":0,"fixedValues":[62.6740306122449]},"license_type":"standard","segmentNames":["sea_waves_windy.wav"],"accessType":"public","soundAtmosId":"094f74b7-19ee-49bf-b647-98e9c8698b25","atmosGeneration":{"type":"static"}},{"name":"train indoor passing by","alias":"train_indoor_passing_by","samples":{},"layers":null,"tags":null,"durations":{"min":13.001831065759637,"max":13.001831065759637,"increments":0,"fixedValues":[13.001831065759637]},"license_type":"standard","segmentNames":["train_indoor_passing_by.wav"],"accessType":"public","soundAtmosId":"3d587f5e-7730-421c-b018-64232faf7dee","atmosGeneration":{"type":"static"}},{"name":"cricket match","alias":"cricket_match","samples":{},"layers":null,"tags":null,"durations":{"min":74.39641156462585,"max":74.39641156462585,"increments":0,"fixedValues":[74.39641156462585]},"license_type":"standard","segmentNames":["cricket_match.wav"],"accessType":"public","soundAtmosId":"a9caf569-4b6b-43da-872b-a78d083c8405","atmosGeneration":{"type":"static"}},{"name":"traffic light","alias":"traffic_light","samples":{},"layers":null,"tags":null,"durations":{"min":64.50183106575963,"max":64.50183106575963,"increments":0,"fixedValues":[64.50183106575963]},"license_type":"standard","segmentNames":["traffic_light.wav"],"accessType":"public","soundAtmosId":"e10a2d16-b87b-4b3e-ac58-e8862e99c2dd","atmosGeneration":{"type":"static"}},{"name":"storm thunder distant","alias":"storm_thunder_distant","samples":{},"layers":null,"tags":null,"durations":{"min":27.00183106575964,"max":27.00183106575964,"increments":0,"fixedValues":[27.00183106575964]},"license_type":"standard","segmentNames":["storm_thunder_distant.wav"],"accessType":"public","soundAtmosId":"5b1adb3e-03ec-4945-b5f2-dc9edf3461dd","atmosGeneration":{"type":"static"}},{"name":"train station ambient","alias":"train_station_ambient","samples":{},"layers":null,"tags":null,"durations":{"min":47.826819727891156,"max":47.826819727891156,"increments":0,"fixedValues":[47.826819727891156]},"license_type":"standard","segmentNames":["train_station_ambient.wav"],"accessType":"public","soundAtmosId":"05fc4e69-cbd6-4846-b7f1-08fa05370231","atmosGeneration":{"type":"static"}},{"name":"cricket playthrough","alias":"cricket_playthrough","samples":{},"layers":null,"tags":null,"durations":{"min":58.327749433106575,"max":58.327749433106575,"increments":0,"fixedValues":[58.327749433106575]},"license_type":"standard","segmentNames":["cricket_playthrough.wav"],"accessType":"public","soundAtmosId":"8280833c-e1e0-44c0-b5d0-0fc6215e545f","atmosGeneration":{"type":"static"}},{"name":"train fast pass by","alias":"train_fast_pass_by","samples":{},"layers":null,"tags":null,"durations":{"min":72.00183106575963,"max":72.00183106575963,"increments":0,"fixedValues":[72.00183106575963]},"license_type":"standard","segmentNames":["train_fast_pass_by.wav"],"accessType":"public","soundAtmosId":"0fe0b609-a15e-4828-bd26-c6300afb71bf","atmosGeneration":{"type":"static"}},{"name":"wind whistle","alias":"wind_whistle","samples":{},"layers":null,"tags":null,"durations":{"min":24.312896825396827,"max":24.312896825396827,"increments":0,"fixedValues":[24.312896825396827]},"license_type":"standard","segmentNames":["wind_whistle.wav"],"accessType":"public","soundAtmosId":"c032382d-fd02-449c-acb2-fcc5550ca4c7","atmosGeneration":{"type":"static"}},{"name":"train indoor departure","alias":"train_indoor_departure","samples":{},"layers":null,"tags":null,"durations":{"min":106.82493764172335,"max":106.82493764172335,"increments":0,"fixedValues":[106.82493764172335]},"license_type":"standard","segmentNames":["train_indoor_departure.wav"],"accessType":"public","soundAtmosId":"6f5a1aea-7762-4e24-8a6e-a23b80f45fd0","atmosGeneration":{"type":"static"}},{"name":"bus stop","alias":"bus_stop","samples":{},"layers":null,"tags":null,"durations":{"min":64.0748015873016,"max":64.0748015873016,"increments":0,"fixedValues":[64.0748015873016]},"license_type":"standard","segmentNames":["bus_stop.wav"],"accessType":"public","soundAtmosId":"56779f41-6818-4a20-9a74-13f88fe52cfa","atmosGeneration":{"type":"static"}},{"name":"carnival rave","alias":"carnival_rave","samples":{},"layers":null,"tags":null,"durations":{"min":41.46657029478458,"max":41.46657029478458,"increments":0,"fixedValues":[41.46657029478458]},"license_type":"standard","segmentNames":["carnival_rave.wav"],"accessType":"public","soundAtmosId":"3ffdca30-3f0b-4363-8333-96e2166d6afa","atmosGeneration":{"type":"static"}},{"name":"sea waves","alias":"sea_waves","samples":{},"layers":null,"tags":null,"durations":{"min":57.40704648526077,"max":57.40704648526077,"increments":0,"fixedValues":[57.40704648526077]},"license_type":"standard","segmentNames":["sea_waves.wav"],"accessType":"public","soundAtmosId":"de1df718-de84-4aa5-b315-41e5b42f290e","atmosGeneration":{"type":"static"}},{"name":"football stadium ambience","alias":"football_stadium_ambience","samples":{},"layers":null,"tags":null,"durations":{"min":41.00183106575964,"max":41.00183106575964,"increments":0,"fixedValues":[41.00183106575964]},"license_type":"standard","segmentNames":["football_stadium_ambience.wav"],"accessType":"public","soundAtmosId":"17ccf06d-c9ee-4345-a5d4-9849311a3988","atmosGeneration":{"type":"static"}},{"name":"jungle dawn","alias":"jungle_dawn","samples":{},"layers":null,"tags":null,"durations":{"min":92.24861111111112,"max":92.24861111111112,"increments":0,"fixedValues":[92.24861111111112]},"license_type":"standard","segmentNames":["jungle_dawn.wav"],"accessType":"public","soundAtmosId":"9d80c201-bccc-44db-91da-17da182e21cc","atmosGeneration":{"type":"static"}},{"name":"boxing round start","alias":"boxing_round_start","samples":{},"layers":null,"tags":null,"durations":{"min":58.00183106575964,"max":58.00183106575964,"increments":0,"fixedValues":[58.00183106575964]},"license_type":"standard","segmentNames":["boxing_round_start.wav"],"accessType":"public","soundAtmosId":"5e00e940-62d5-4015-8e7d-6bea2f089240","atmosGeneration":{"type":"static"}},{"name":"football ovation","alias":"football_ovation","samples":{},"layers":null,"tags":null,"durations":{"min":30.88890589569161,"max":30.88890589569161,"increments":0,"fixedValues":[30.88890589569161]},"license_type":"standard","segmentNames":["football_ovation.wav"],"accessType":"public","soundAtmosId":"2dba99c6-9629-4fbd-adf8-ae226aa3c036","atmosGeneration":{"type":"static"}},{"name":"cafe busy","alias":"cafe_busy","samples":{},"layers":null,"tags":null,"durations":{"min":15.001831065759637,"max":15.001831065759637,"increments":0,"fixedValues":[15.001831065759637]},"license_type":"standard","segmentNames":["cafe_busy.wav"],"accessType":"public","soundAtmosId":"3a50ae4a-98eb-4afe-b52e-184d6ecbd60a","atmosGeneration":{"type":"static"}},{"name":"aeroplane take off loud","alias":"aeroplane_take_off_loud","samples":{},"layers":null,"tags":null,"durations":{"min":21.00183106575964,"max":21.00183106575964,"increments":0,"fixedValues":[21.00183106575964]},"license_type":"standard","segmentNames":["aeroplane_take_off_loud.wav"],"accessType":"public","soundAtmosId":"28f2bb50-59ad-4265-a003-9ed620ba14e7","atmosGeneration":{"type":"static"}},{"name":"tennis score announcement","alias":"tennis_score_announcement","samples":{},"layers":null,"tags":null,"durations":{"min":8.001831065759637,"max":8.001831065759637,"increments":0,"fixedValues":[8.001831065759637]},"license_type":"standard","segmentNames":["tennis_score_announcement.wav"],"accessType":"public","soundAtmosId":"3dc9ea4b-b9b8-4be5-b751-a85988bb0099","atmosGeneration":{"type":"static"}},{"name":"storm closer","alias":"storm_closer","samples":{},"layers":null,"tags":null,"durations":{"min":62.286162131519276,"max":62.286162131519276,"increments":0,"fixedValues":[62.286162131519276]},"license_type":"standard","segmentNames":["storm_closer.wav"],"accessType":"public","soundAtmosId":"84cf826d-4814-408f-abcf-6cb60747e91a","atmosGeneration":{"type":"static"}},{"name":"swimming pool indoors","alias":"swimming_pool_indoors","samples":{},"layers":null,"tags":null,"durations":{"min":50.07629818594104,"max":50.07629818594104,"increments":0,"fixedValues":[50.07629818594104]},"license_type":"standard","segmentNames":["swimming_pool_indoors.wav"],"accessType":"public","soundAtmosId":"4079605f-1f6b-49be-8e1c-d01e2976923e","atmosGeneration":{"type":"static"}},{"name":"train station ambience","alias":"train_station_ambience","samples":{},"layers":null,"tags":null,"durations":{"min":31.00183106575964,"max":31.00183106575964,"increments":0,"fixedValues":[31.00183106575964]},"license_type":"standard","segmentNames":["train_station_ambience.wav"],"accessType":"public","soundAtmosId":"9ec975bf-d185-4648-b8be-aa89b51bda83","atmosGeneration":{"type":"static"}},{"name":"running jogging","alias":"running_jogging","samples":{},"layers":null,"tags":null,"durations":{"min":10.95328231292517,"max":10.95328231292517,"increments":0,"fixedValues":[10.95328231292517]},"license_type":"standard","segmentNames":["running_jogging.wav"],"accessType":"public","soundAtmosId":"5db771af-6c16-4823-97a0-d4ad7fcd1c70","atmosGeneration":{"type":"static"}},{"name":"train approaching","alias":"train_approaching","samples":{},"layers":null,"tags":null,"durations":{"min":22.666819727891156,"max":22.666819727891156,"increments":0,"fixedValues":[22.666819727891156]},"license_type":"standard","segmentNames":["train_approaching.wav"],"accessType":"public","soundAtmosId":"cb0a137a-44ff-43db-bca1-ec028f69dfdf","atmosGeneration":{"type":"static"}},{"name":"train pass by left to right","alias":"train_pass_by_left_to_right","samples":{},"layers":null,"tags":null,"durations":{"min":15.001831065759637,"max":15.001831065759637,"increments":0,"fixedValues":[15.001831065759637]},"license_type":"standard","segmentNames":["train_pass_by_left_to_right.wav"],"accessType":"public","soundAtmosId":"d235598e-5ccc-4071-9d8e-3037027d6602","atmosGeneration":{"type":"static"}},{"name":"cafe medium","alias":"cafe_medium","samples":{},"layers":null,"tags":null,"durations":{"min":41.971785714285716,"max":41.971785714285716,"increments":0,"fixedValues":[41.971785714285716]},"license_type":"standard","segmentNames":["cafe_medium.wav"],"accessType":"public","soundAtmosId":"38849d2f-f505-419b-97b7-a889b264c45a","atmosGeneration":{"type":"static"}},{"name":"train departure","alias":"train_departure","samples":{},"layers":null,"tags":null,"durations":{"min":16.67418934240363,"max":16.67418934240363,"increments":0,"fixedValues":[16.67418934240363]},"license_type":"standard","segmentNames":["train_departure.wav"],"accessType":"public","soundAtmosId":"3bf12d3f-4b6a-4e5a-990b-e7263b5fedda","atmosGeneration":{"type":"static"}},{"name":"cafe busy ambience","alias":"cafe_busy_ambience","samples":{},"layers":null,"tags":null,"durations":{"min":47.70983560090703,"max":47.70983560090703,"increments":0,"fixedValues":[47.70983560090703]},"license_type":"standard","segmentNames":["cafe_busy_ambience.wav"],"accessType":"public","soundAtmosId":"a5fd85ac-a26c-4106-966f-5e8f51da6620","atmosGeneration":{"type":"static"}},{"name":"football goal","alias":"football_goal","samples":{},"layers":null,"tags":null,"durations":{"min":51.0534410430839,"max":51.0534410430839,"increments":0,"fixedValues":[51.0534410430839]},"license_type":"standard","segmentNames":["football_goal.wav"],"accessType":"public","soundAtmosId":"00fe0d8c-803e-437a-be3e-7ef70c3dedc1","atmosGeneration":{"type":"static"}},{"name":"art gallery","alias":"art_gallery","samples":{},"layers":null,"tags":null,"durations":{"min":81.22203514739229,"max":81.22203514739229,"increments":0,"fixedValues":[81.22203514739229]},"license_type":"standard","segmentNames":["art_gallery.wav"],"accessType":"public","soundAtmosId":"aec3fb86-8356-4137-a49e-1507ae4f3493","atmosGeneration":{"type":"static"}},{"name":"boxing fighting","alias":"boxing_fighting","samples":{},"layers":null,"tags":null,"durations":{"min":39.00183106575964,"max":39.00183106575964,"increments":0,"fixedValues":[39.00183106575964]},"license_type":"standard","segmentNames":["boxing_fighting.wav"],"accessType":"public","soundAtmosId":"0b8aea43-c194-447e-bcc6-0b73af210be1","atmosGeneration":{"type":"static"}},{"name":"cooking fry","alias":"cooking_fry","samples":{},"layers":null,"tags":null,"durations":{"min":5.989336734693878,"max":5.989336734693878,"increments":0,"fixedValues":[5.989336734693878]},"license_type":"standard","segmentNames":["cooking_fry.wav"],"accessType":"public","soundAtmosId":"08dc4b1d-b1cb-4b10-b13e-791c3d3df72f","atmosGeneration":{"type":"static"}},{"name":"traffic city","alias":"traffic_city","samples":{},"layers":null,"tags":null,"durations":{"min":64.87684240362812,"max":64.87684240362812,"increments":0,"fixedValues":[64.87684240362812]},"license_type":"standard","segmentNames":["traffic_city.wav"],"accessType":"public","soundAtmosId":"4b1aef1d-c0dc-4e30-8204-d3867561c9d1","atmosGeneration":{"type":"static"}}]},"meta":{"version":"","requestId":"******************","creditsUsed":0,"creditsRemaining":0},"message":"Requested sound atmospheres:","warnings":[]}}}}},"403":{"description":"Could not find a valid api key","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"example":{"message":"Access denied. Could not find a valid organization."}}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}}},"security":[{"ApiKeyAuth":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}