{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}
{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}
{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}
The response comes back straight away, usually with status: "pending" and no attachment.url yet. The audio is generated in the background:
Poll: call Get audio with the returned id every few seconds.
Stop polling when status is completed or failed.
Download: once it’s completed, download the file from attachment.url.
Short text is usually ready within a few seconds.The voice and language are checked before anything is created. An invalid pair returns 400 straight away. See Errors.
If the voice’s engine fails, you don’t get an error here. The audio’s status becomes failed instead. Retry, or try another voice.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Olimi AI","colors":{"primary":"#111111","light":"#999999","dark":"#111111"},"logo":{"light":"https://mintcdn.com/olimi/Z3ML2rZXUsMQ8jzb/logo/light-olimi.svg?fit=max\u0026auto=format\u0026n=Z3ML2rZXUsMQ8jzb\u0026q=85\u0026s=27b6898bcac64fd881d2e404e5cfd8f9","dark":"https://mintcdn.com/olimi/Z3ML2rZXUsMQ8jzb/logo/dark-olimi.svg?fit=max\u0026auto=format\u0026n=Z3ML2rZXUsMQ8jzb\u0026q=85\u0026s=802d73eccb4d28418c54a17ac944c648"},"favicon":"https://mintcdn.com/olimi/Z3ML2rZXUsMQ8jzb/favicon.svg?fit=max\u0026auto=format\u0026n=Z3ML2rZXUsMQ8jzb\u0026q=85\u0026s=4939d39b8b7d446fe9f2fe07308ec8ca","api":{"openapi":["api-reference/openapi.json"]},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://app.olimi.ai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"olimi","hasAudioNarration":false,"actualSubdomain":"olimi","customDomains":["docs.olimi.ai"],"gitSource":{"type":"github","owner":"olimi-ltd","repo":"olimidocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abba64a122d8473aa35651c","collectionId":"9e8177be-72ef-4d00-b0cf-0b18570ad2b3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abba64a122d8473aa35651c"},"entitlements":{},"buildId":"6abba64a122d8473aa35651c","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Agents \u0026 Campaigns","count":22},{"language":"default","tag":"Speech","count":21},{"language":"default","tag":"Speech to Video","count":8},{"language":"default","tag":"Text to Speech","count":7},{"language":"default","tag":"Campaigns","count":6},{"language":"default","tag":"Speech to Text","count":6},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"Agents","count":4},{"language":"default","tag":"Customer Lists","count":4},{"language":"default","tag":"Getting Started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/speech/create-tts","slug":"/api-reference/endpoint/speech/create-tts","pageMetadata":{"title":"Create audio","openapi":"post /api/v2/tts","description":"Starts turning text into speech and returns straight away. The audio is ready when `status` becomes `completed`.","href":"/api-reference/endpoint/speech/create-tts"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Starts turning text into speech and returns straight away. The audio is ready when \", _jsx(_components.code, {\n children: \"status\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"completed\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The response comes back straight away, usually with `,_jsx(_components.code,{children:`status: \"pending\"`}),` and no `,_jsx(_components.code,{children:`attachment.url`}),` yet. The audio is generated in the background:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Poll:`}),` call `,_jsx(_components.a,{href:`/api-reference/endpoint/speech/get-tts`,children:`Get audio`}),` with the returned `,_jsx(_components.code,{children:`id`}),` every few seconds.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Stop polling`}),` when `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`completed`}),` or `,_jsx(_components.code,{children:`failed`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Download:`}),` once it’s `,_jsx(_components.code,{children:`completed`}),`, download the file from `,_jsx(_components.code,{children:`attachment.url`}),`.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Short text is usually ready within a few seconds.`}),`\n`,_jsxs(_components.p,{children:[`The voice and language are checked before anything is created. An invalid pair returns `,_jsx(_components.code,{children:`400`}),` straight away. See `,_jsx(_components.a,{href:`/api-reference/endpoint/speech/text-to-speech#errors`,children:`Errors`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`If the voice’s engine fails, you don’t get an error here. The audio’s `,_jsx(_components.code,{children:`status`}),` becomes `,_jsx(_components.code,{children:`failed`}),` instead. Retry, or try another voice.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create audio","openapi":"post /api/v2/tts","description":"Starts turning text into speech and returns straight away. The audio is ready when `status` becomes `completed`.","href":"/api-reference/endpoint/speech/create-tts"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create audio","description":"Starts turning text into speech and returns straight away. The audio is ready when `status` becomes `completed`.","tags":["Text to Speech"],"security":["cde7f558-9e19-4eb2-9e3b-8ebeed064659"],"requestBody":"78a2e033-d6fa-45b3-97c3-0a3f4e25b5f2","responses":{"201":"2c010ba9-1a6b-4da2-ab0c-db2f5a83f4ed","400":"0b9a740b-c67b-4e45-8e69-3bd4020d7b7c","401":"c181652a-d7c6-4db5-a943-5dcecb7ca700","422":"f2950571-b0e1-4f5b-a2a6-99baa9a2c560"},"method":"post","type":"path","servers":["3cabd987-821f-4e55-8cec-f6a014192c9f"],"path":"/api/v2/tts","baseUrlOptions":["https://api-eg.olimi.ai"],"title":"Create audio","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["input","languageId","voiceId"],"properties":{"input":{"type":"string","minLength":1,"description":"The text to speak.","example":"أهلاً بيك، إزيك النهارده؟","isRequired":true,"uniqueKey":"input","typeLabel":"string"},"languageId":{"type":"string","format":"uuid","description":"From [List languages](/api-reference/endpoint/speech/list-tts-languages).","example":"2cdab2de-310d-59a3-ad68-b85b4526e37b","isRequired":true,"uniqueKey":"languageId","typeLabel":"string\u003cuuid>"},"voiceId":{"type":"string","format":"uuid","description":"From [List voices](/api-reference/endpoint/speech/list-tts-voices).","example":"118d2470-de1d-5093-86b3-f2d8adec3183","isRequired":true,"uniqueKey":"voiceId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"A label for the audio. Becomes the file name. Defaults to `TTS_\u003ctimestamp>`.","example":"greeting","uniqueKey":"name","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"input":"أهلاً بيك، إزيك النهارده؟","languageId":"2cdab2de-310d-59a3-ad68-b85b4526e37b","voiceId":"118d2470-de1d-5093-86b3-f2d8adec3183","name":"greeting"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2c010ba9-1a6b-4da2-ab0c-db2f5a83f4ed":{"description":"The new audio, usually with `status` `pending`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Text-to-speech record fetched successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The audio's ID.","example":"457ede41-97c7-44c6-bdd8-b9e4ca37f812","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Your label, or `TTS_\u003ctimestamp>` if you didn't send one.","example":"greeting","uniqueKey":"data.name","typeLabel":"string"},"input":{"type":"string","description":"The text that was spoken.","example":"أهلاً بيك، إزيك النهارده؟","uniqueKey":"data.input","typeLabel":"string"},"status":{"type":"string","enum":["pending","completed","failed"],"description":"See [Status values](/api-reference/endpoint/speech/text-to-speech#status-values).","example":"completed","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"duration":{"type":"integer","description":"Length of the audio in seconds, rounded down. `0` until the audio is ready.","example":2,"uniqueKey":"data.duration","typeLabel":"integer"},"responseFormat":{"type":"string","description":"Always `pcm`: the encoding inside the WAV file.","example":"pcm","uniqueKey":"data.responseFormat","typeLabel":"string"},"languageId":{"type":"string","format":"uuid","example":"2cdab2de-310d-59a3-ad68-b85b4526e37b","uniqueKey":"data.languageId","typeLabel":"string\u003cuuid>"},"voiceId":{"type":"string","format":"uuid","example":"118d2470-de1d-5093-86b3-f2d8adec3183","uniqueKey":"data.voiceId","typeLabel":"string\u003cuuid>"},"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"d853213e-03da-49af-8d7b-81a818d1a296","uniqueKey":"data.attachment.id","typeLabel":"string\u003cuuid>"},"originalName":{"type":"string","description":"The file name: your `name` plus `.wav`.","example":"greeting.wav","uniqueKey":"data.attachment.originalName","typeLabel":"string"},"mimeType":{"type":"string","example":"audio/wav","uniqueKey":"data.attachment.mimeType","typeLabel":"string"},"fileSize":{"type":"string","description":"Size in bytes, as a string. `0` until the audio is ready.","example":"128684","uniqueKey":"data.attachment.fileSize","typeLabel":"string"},"url":{"oneOf":[{"type":"string","description":"A temporary download link. Only present once `status` is `completed`; expires after one hour.","example":"https://\u003cstorage-host>/tts/d853213e-03da-49af-8d7b-81a818d1a296?X-Amz-Expires=3600\u0026X-Amz-Signature=…","uniqueKey":"data.attachment.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A temporary download link. Only present once `status` is `completed`; expires after one hour.","example":"https://\u003cstorage-host>/tts/d853213e-03da-49af-8d7b-81a818d1a296?X-Amz-Expires=3600\u0026X-Amz-Signature=…","uniqueKey":"data.attachment.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attachment.url","typeLabel":"string | null"}},"uniqueKey":"data.attachment","typeLabel":"object"},"language":{"type":"object","properties":{"code":{"type":"string","example":"ar-EG","uniqueKey":"data.language.code","typeLabel":"string"},"name":{"type":"string","example":"Arabic - Egyptian","uniqueKey":"data.language.name","typeLabel":"string"}},"uniqueKey":"data.language","typeLabel":"object"},"voice":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"118d2470-de1d-5093-86b3-f2d8adec3183","uniqueKey":"data.voice.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Farida","uniqueKey":"data.voice.name","typeLabel":"string"},"voiceKey":{"type":"string","example":"Kore","uniqueKey":"data.voice.voiceKey","typeLabel":"string"}},"uniqueKey":"data.voice","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","example":"2026-09-29T09:05:44.045Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2026-09-29T09:05:47.310Z","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Text-to-speech record fetched successfully","data":{"id":"457ede41-97c7-44c6-bdd8-b9e4ca37f812","name":"greeting","input":"أهلاً بيك، إزيك النهارده؟","status":"completed","duration":2,"responseFormat":"pcm","languageId":"2cdab2de-310d-59a3-ad68-b85b4526e37b","voiceId":"118d2470-de1d-5093-86b3-f2d8adec3183","attachment":{"id":"d853213e-03da-49af-8d7b-81a818d1a296","originalName":"greeting.wav","mimeType":"audio/wav","fileSize":"128684","url":"https://\u003cstorage-host>/tts/d853213e-03da-49af-8d7b-81a818d1a296?X-Amz-Expires=3600\u0026X-Amz-Signature=…"},"language":{"code":"ar-EG","name":"Arabic - Egyptian"},"voice":{"id":"118d2470-de1d-5093-86b3-f2d8adec3183","name":"Farida","voiceKey":"Kore"},"createdAt":"2026-09-29T09:05:44.045Z","updatedAt":"2026-09-29T09:05:47.310Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0b9a740b-c67b-4e45-8e69-3bd4020d7b7c":{"description":"`tts_language_not_supported` (the language doesn't exist or isn't available for speech), `tts_voice_not_supported` or `voice_language_not_compatible`. See [Errors](/api-reference/endpoint/speech/text-to-speech#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"uniqueKey":"statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Machine-readable error code.","example":"agent_not_found","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable text. May change; don't match on it.","example":"Agent not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"errorCode":"agent_not_found","message":"Agent not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"c181652a-d7c6-4db5-a943-5dcecb7ca700":{"description":"The `X-API-KEY` header is missing or the key isn't valid.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"uniqueKey":"statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Machine-readable error code.","example":"agent_not_found","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable text. May change; don't match on it.","example":"Agent not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"errorCode":"agent_not_found","message":"Agent not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"f2950571-b0e1-4f5b-a2a6-99baa9a2c560":{"description":"The request body didn't pass validation.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":422,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"array","items":{"type":"string","uniqueKey":"message.items.[INDEX]","typeLabel":"string"},"description":"What went wrong. Human-readable.","example":["name must be shorter than or equal to 100 characters"],"uniqueKey":"message","typeLabel":"string[]"},"error":{"type":"string","example":"Unprocessable Entity","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":422,"message":["name must be shorter than or equal to 100 characters"],"error":"Unprocessable Entity"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cde7f558-9e19-4eb2-9e3b-8ebeed064659":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"3cabd987-821f-4e55-8cec-f6a014192c9f":{"url":"https://api-eg.olimi.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-KEY"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"olimi","siteName":"Olimi AI","title":"Create audio - Olimi AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T11:51:53.888Z","originalFileLocation":"api-reference/endpoint/speech/create-tts.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Starts turning text into speech and returns straight away. The audio is ready when status becomes completed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Olimi AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create audio - Olimi AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Starts turning text into speech and returns straight away. The audio is ready when status becomes completed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Olimi AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://olimi.mintlify.app/_mintlify/api/og/v2?division=Text+to+Speech\u0026amp;title=Create+audio\u0026amp;description=Starts+turning+text+into+speech+and+returns+straight+away.+The+audio+is+ready+when+%60status%60+becomes+%60completed%60.\u0026amp;theme=c984395f43d8d9539f01ceef\u0026amp;signature=05c2537c4090e4dbe6952e790d27de163a30cbf05895d0b4611bee64dce8126e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create audio - Olimi AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Starts turning text into speech and returns straight away. The audio is ready when status becomes completed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://olimi.mintlify.app/_mintlify/api/og/v2?division=Text+to+Speech\u0026amp;title=Create+audio\u0026amp;description=Starts+turning+text+into+speech+and+returns+straight+away.+The+audio+is+ready+when+%60status%60+becomes+%60completed%60.\u0026amp;theme=c984395f43d8d9539f01ceef\u0026amp;signature=05c2537c4090e4dbe6952e790d27de163a30cbf05895d0b4611bee64dce8126e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/olimi/sSM7fJ5EVcZkWuGs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Olimi AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/speech/create-tts.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.olimi.ai/#organization\",\"name\":\"Olimi AI\",\"url\":\"https://docs.olimi.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/olimi/Z3ML2rZXUsMQ8jzb/logo/light-olimi.svg?fit=max\u0026auto=format\u0026n=Z3ML2rZXUsMQ8jzb\u0026q=85\u0026s=27b6898bcac64fd881d2e404e5cfd8f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.olimi.ai#website\",\"name\":\"Olimi AI\",\"url\":\"https://docs.olimi.ai\",\"publisher\":{\"@id\":\"https://docs.olimi.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts#webpage\",\"url\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts\",\"name\":\"Create audio\",\"description\":\"Starts turning text into speech and returns straight away. The audio is ready when status becomes completed.\",\"dateModified\":\"2026-09-29T11:51:53.888Z\",\"isPartOf\":{\"@id\":\"https://docs.olimi.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Speech\",\"item\":\"https://docs.olimi.ai/api-reference/endpoint/speech/text-to-speech\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Text to Speech\",\"item\":\"https://docs.olimi.ai/api-reference/endpoint/speech/text-to-speech\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create audio\",\"item\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts#apireference\",\"headline\":\"Create audio\",\"name\":\"Create audio\",\"description\":\"Starts turning text into speech and returns straight away. The audio is ready when status becomes completed.\",\"url\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts\",\"mainEntityOfPage\":{\"@id\":\"https://docs.olimi.ai/api-reference/endpoint/speech/create-tts#webpage\"},\"dateModified\":\"2026-09-29T11:51:53.888Z\",\"publisher\":{\"@id\":\"https://docs.olimi.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.olimi.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Olimi AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Olimi AI","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Account Setup","href":"/account-setup"},{"title":"PBX Installation","href":"/installation"}]},{"group":"API Overview","pages":[{"title":"Webhook Overview","icon":"webhook","href":"/webhook/webhook"},{"title":"API Authentication","icon":"gear-code","href":"/api-auth"}]},{"group":"Agents \u0026 Campaigns","pages":[{"group":"Agents","icon":"robot","pages":[{"title":"Agents","sidebarTitle":"Overview","href":"/api-reference/endpoint/agent/agents"},{"title":"List agents","openapi":"get /api/v2/agents","href":"/api-reference/endpoint/agent/list-agents"},{"title":"Get an agent","openapi":"get /api/v2/agents/{id}","href":"/api-reference/endpoint/agent/get-agent"},{"title":"Update an agent","openapi":"patch /api/v2/agents/{id}","href":"/api-reference/endpoint/agent/update-agent"}]},{"group":"Customer Lists","icon":"list","pages":[{"title":"Customer Lists","sidebarTitle":"Overview","href":"/api-reference/endpoint/customer-list/customer-lists"},{"title":"List customer lists","openapi":"get /api/v2/customer-lists","href":"/api-reference/endpoint/customer-list/list-customer-lists"},{"title":"Get a customer list","openapi":"get /api/v2/customer-lists/{id}","href":"/api-reference/endpoint/customer-list/get-customer-list"},{"title":"Create a customer list","openapi":"post /api/v2/customer-lists","href":"/api-reference/endpoint/customer-list/create-customer-list"}]},{"group":"Contacts","icon":"address-book","pages":[{"title":"Contacts","sidebarTitle":"Overview","href":"/api-reference/endpoint/contacts/contacts"},{"title":"List contacts","openapi":"get /api/v2/contacts/{customerListId}","href":"/api-reference/endpoint/contacts/list-contacts"},{"title":"Add a contact","openapi":"post /api/v2/contacts","href":"/api-reference/endpoint/contacts/create-contact"},{"title":"Edit a contact","openapi":"patch /api/v2/contacts/{id}","href":"/api-reference/endpoint/contacts/update-contact"},{"title":"Delete a contact","openapi":"delete /api/v2/contacts/{id}","href":"/api-reference/endpoint/contacts/delete-contact"}]},{"group":"Campaigns","icon":"bullhorn","pages":[{"title":"Campaigns","sidebarTitle":"Overview","href":"/api-reference/endpoint/campaigns/campaigns"},{"title":"List campaigns","openapi":"get /api/v2/campaigns","href":"/api-reference/endpoint/campaigns/list-campaigns"},{"title":"Get a campaign","openapi":"get /api/v2/campaigns/{id}","href":"/api-reference/endpoint/campaigns/get-campaign"},{"title":"Create a campaign","openapi":"post /api/v2/campaigns","href":"/api-reference/endpoint/campaigns/create-campaign"},{"title":"Update a campaign","openapi":"patch /api/v2/campaigns/{id}","href":"/api-reference/endpoint/campaigns/update-campaign"},{"title":"Delete a campaign","openapi":"delete /api/v2/campaigns/{id}","href":"/api-reference/endpoint/campaigns/delete-campaign"}]},{"group":"Calls","icon":"phone","pages":[{"title":"Calls","sidebarTitle":"Overview","href":"/api-reference/endpoint/calls/calls"},{"title":"List calls","openapi":"get /api/v2/calls","href":"/api-reference/endpoint/calls/list-calls"},{"title":"Get a call","openapi":"get /api/v2/calls/{id}","href":"/api-reference/endpoint/calls/get-call"}]}]},{"group":"Speech","pages":[{"group":"Text to Speech","icon":"volume-high","pages":[{"title":"Text to Speech","sidebarTitle":"Overview","href":"/api-reference/endpoint/speech/text-to-speech"},{"title":"List languages","openapi":"get /api/v2/languages/public","href":"/api-reference/endpoint/speech/list-tts-languages"},{"title":"List voices","openapi":"get /api/v2/tts/voices","description":"Returns the voices that can speak a language.","href":"/api-reference/endpoint/speech/list-tts-voices"},{"title":"Create audio","openapi":"post /api/v2/tts","href":"/api-reference/endpoint/speech/create-tts"},{"title":"List audio","openapi":"get /api/v2/tts","description":"Returns the audio you've created, newest first, one page at a time.","href":"/api-reference/endpoint/speech/list-tts"},{"title":"Get audio","openapi":"get /api/v2/tts/{id}","href":"/api-reference/endpoint/speech/get-tts"},{"title":"Delete audio","openapi":"delete /api/v2/tts/{id}","href":"/api-reference/endpoint/speech/delete-tts"}]},{"group":"Speech to Text","icon":"closed-captioning","pages":[{"title":"Speech to Text","sidebarTitle":"Overview","href":"/api-reference/endpoint/speech/speech-to-text"},{"title":"Upload audio","openapi":"post /api/v2/stt/upload","href":"/api-reference/endpoint/speech/upload-stt"},{"title":"List transcripts","openapi":"get /api/v2/stt","href":"/api-reference/endpoint/speech/list-stt"},{"title":"Get a transcript","openapi":"get /api/v2/stt/{id}","href":"/api-reference/endpoint/speech/get-stt"},{"title":"Regenerate a transcript","openapi":"post /api/v2/stt/{id}/regenerate","href":"/api-reference/endpoint/speech/regenerate-stt"},{"title":"Delete a transcript","openapi":"delete /api/v2/stt/{id}","href":"/api-reference/endpoint/speech/delete-stt"}]},{"group":"Speech to Video","icon":"video","pages":[{"title":"Speech to Video","sidebarTitle":"Overview","href":"/api-reference/endpoint/speech/speech-to-video"},{"title":"List avatars","openapi":"get /api/v2/stv/avatars","href":"/api-reference/endpoint/speech/list-stv-avatars"},{"title":"Create a video","openapi":"post /api/v2/stv","href":"/api-reference/endpoint/speech/create-stv"},{"title":"Get video progress","openapi":"get /api/v2/stv/progress/{id}","href":"/api-reference/endpoint/speech/get-stv-progress"},{"title":"List videos","openapi":"get /api/v2/stv","href":"/api-reference/endpoint/speech/list-stv"},{"title":"Get a video","openapi":"get /api/v2/stv/{id}","href":"/api-reference/endpoint/speech/get-stv"},{"title":"Download a video","openapi":"get /api/v2/stv/{id}/download","href":"/api-reference/endpoint/speech/download-stv"},{"title":"Delete a video","openapi":"delete /api/v2/stv/{id}","href":"/api-reference/endpoint/speech/delete-stv"}]}]}]},"title":"Create audio - Olimi AI","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}