CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><script id="_fern-ga-init"> window['dataLayer'] = window['dataLayer'] || []; function gtag(){window['dataLayer'].push(arguments);} gtag('js', new Date()); gtag('config', 'G-82RG1PXYVW' );</script><link rel="preload" href="/docs/api/fern-docs/search/v2/key" as="fetch" crossorigin="anonymous"/><link rel="preload" href="/docs/api/fern-docs/auth/api-key-injection" as="fetch" crossorigin="anonymous"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"/><title>Introduction — ElevenLabs Documentation</title><meta name="robots" content="index,follow"/><meta name="description" content="Welcome to the ElevenLabs API reference."/><meta name="theme-color" content="#ffffff"/><meta property="og:title" content="Introduction — ElevenLabs Documentation"/><meta property="og:description" content="Welcome to the ElevenLabs API reference."/><meta property="og:url" content="https://elevenlabs.io/docs/api-reference/introduction"/><meta property="og:site_name" content="ElevenLabs Documentation"/><link rel="canonical" href="https://elevenlabs.io/docs/api-reference/introduction"/><meta name="generator" content="buildwithfern.com"/><link rel="icon" href="https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/favicon.svg" crossorigin="anonymous"/><script type="application/ld+json" id="jsonld-breadcrumb">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"ElevenLabs Documentation","item":"https://elevenlabs.io/docs"},{"@type":"ListItem","position":2,"name":"API REFERENCE","item":"https://elevenlabs.io/docs/api-reference"},{"@type":"ListItem","position":3,"name":"Introduction","item":"https://elevenlabs.io/docs/api-reference/introduction"}]}</script><link rel="preload" href="https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-light.svg" as="image" fetchpriority="high"/><link rel="preload" href="https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-dark.svg" as="image" fetchpriority="high"/><meta name="next-head-count" content="19"/><link href="https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css" rel="stylesheet"/><script id="theme-script" data-nscript="beforeInteractive">(e=>{let t=document.documentElement;function n(e){t.classList.remove("light","dark"),t.classList.add(e),t.style.colorScheme=e}if(1===e.length)n(e[0]);else try{let t=localStorage.getItem("theme")??"system",r=e.length>0&&"system"===t?window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light":t;n(r)}catch{}})(["light","dark"])</script><link rel="preload" href="https://app.buildwithfern.com/_next/static/css/9ea35506dfe64fe9.css?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" as="style"/><link rel="stylesheet" href="https://app.buildwithfern.com/_next/static/css/9ea35506dfe64fe9.css?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" data-n-g=""/><link rel="preload" href="https://app.buildwithfern.com/_next/static/css/80bca615e6d01b34.css?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" as="style"/><link rel="stylesheet" href="https://app.buildwithfern.com/_next/static/css/80bca615e6d01b34.css?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="https://app.buildwithfern.com/_next/static/chunks/polyfills-78c92fac7aa8fdd8.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8494.89309af69f67ac9d.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/7191.7664a652cf78e25c.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9326.7b77fad76298e73f.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/45bb0db8.463a392675fecfb0.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/92e66809.393f81705c519a34.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/118f301d.0a7382916ef4ac18.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/52d2be3c.b954481fe5a6d824.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/f29dc6a8.0d3c3c8683df2eda.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/6003.c51da136c4cdc4e2.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8950.bc07b3e1c13f1432.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9447.941fe43d074e9d65.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/3970.92d61b16d27aa382.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/600.0f4ff2048e86ee7c.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9288.0aaefe04365bfd8c.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/f136264b.fe05aaa57e22d479.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/4217.08fff909190d4e30.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2729.42c77bdb2d91a65d.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9042.134772d83f368551.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8326.bde182ef6c372b2f.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/6454.e75e869621219b83.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8508.347822f577367398.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5288.18b11dcf52fa881c.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5119.7fbcb17fea114486.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5438.9dfc11fa11c8ee42.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/6770.0df1af542f2705d9.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/1687.ba3b68ce6ef227a3.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/a20b1002.4488a96695dd3fd2.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2190.87861bd25f72541a.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8909.f1f37f32cfbdca2f.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5817.f22ecadc7348b099.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5777.8b41b53f8bbbac5b.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/7575.070541bff847f988.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/3a1e8fa5.f424dc5b27f92fae.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/0af31c8c.03b4dfb2870a7087.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/1984.64ddbf5f61548f82.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2359.712319ab69f1d6ae.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp"></script><script src="https://app.buildwithfern.com/_next/static/chunks/webpack-7e592fccf8138b5d.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/framework-66d89474ad83799b.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/main-5d1e3213caa159c8.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/pages/_app-1fe0aae8d9cc7b47.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/2709-cda5da4a8db8de58.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/6053-cf2b715dfe155a82.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/pages/static/%5Bdomain%5D/%5B%5B...slug%5D%5D-31f428dae64597dc.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/gASoyzmfnGsTVn-yBp1nS/_buildManifest.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><script src="https://app.buildwithfern.com/_next/static/gASoyzmfnGsTVn-yBp1nS/_ssgManifest.js?dpl=dpl_BZsgQPPJwDDDAUoQHuFLXfqeDGHp" defer=""></script><style id="__jsx-343298179"> :root { --typography-body-font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-heading-font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-code-font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace; --spacing-page-width: 100%; --spacing-content-width: 44rem; --spacing-content-wide-width: 66.5rem; --spacing-sidebar-width: 240px; --spacing-header-height: 5.875rem; --spacing-header-height-padded: 66px; --spacing-header-height-real: 3.125rem; --grayscale-1: var(--gray-1); --grayscale-2: var(--gray-2); --grayscale-3: var(--gray-3); --grayscale-4: var(--gray-4); --grayscale-5: var(--gray-5); --grayscale-6: var(--gray-6); --grayscale-7: var(--gray-7); --grayscale-8: var(--gray-8); --grayscale-9: var(--gray-9); --grayscale-10: var(--gray-10); --grayscale-11: var(--gray-11); --grayscale-12: var(--gray-12); --grayscale-a1: var(--gray-a1); --grayscale-a2: var(--gray-a2); --grayscale-a3: var(--gray-a3); --grayscale-a4: var(--gray-a4); --grayscale-a5: var(--gray-a5); --grayscale-a6: var(--gray-a6); --grayscale-a7: var(--gray-a7); --grayscale-a8: var(--gray-a8); --grayscale-a9: var(--gray-a9); --grayscale-a10: var(--gray-a10); --grayscale-a11: var(--gray-a11); --grayscale-a12: var(--gray-a12); --accent-1: #fdfdfd; --accent-2: #fafafa; --accent-3: #f2f2f2; --accent-4: #e9e9e9; --accent-5: #e0e0e0; --accent-6: #d3d3d3; --accent-7: #c4c4c4; --accent-8: #afafaf; --accent-9: #404040; --accent-10: #515151; --accent-11: #6c6c6c; --accent-12: #383838; --accent-a1: #00000002; --accent-a2: #00000005; --accent-a3: #0000000d; --accent-a4: #00000016; --accent-a5: #0000001f; --accent-a6: #0000002c; --accent-a7: #0000003b; --accent-a8: #00000050; --accent-a9: #000000bf; --accent-a10: #000000ae; --accent-a11: #00000093; --accent-a12: #000000c7; --accent-surface: #f9f9f9cc; --gray-surface: #ffffffcc; --accent: 64, 64, 64; --accent-aa: 64, 64, 64; --accent-aaa: 64, 64, 64; --accent-tinted: 51, 51, 51; --background: 255, 255, 255; --accent-contrast: rgb(255, 255, 255); --bg-color-card: rgba(255, 255, 255, 0.7); --sidebar-background: rgb(255, 255, 255); --header-background: rgb(255, 255, 255); --border: var(--grayscale-a4); --border-concealed: var(--grayscale-a2); --body-text: 0, 0, 0; --body-text-inverted: 255, 255, 255; } @media (max-width: 1024px) { :root { --spacing-header-height: 5.875rem; --spacing-header-height-padded: 66px; } } :is(.dark) { --grayscale-1: var(--gray-1); --grayscale-2: var(--gray-2); --grayscale-3: var(--gray-3); --grayscale-4: var(--gray-4); --grayscale-5: var(--gray-5); --grayscale-6: var(--gray-6); --grayscale-7: var(--gray-7); --grayscale-8: var(--gray-8); --grayscale-9: var(--gray-9); --grayscale-10: var(--gray-10); --grayscale-11: var(--gray-11); --grayscale-12: var(--gray-12); --grayscale-a1: var(--gray-a1); --grayscale-a2: var(--gray-a2); --grayscale-a3: var(--gray-a3); --grayscale-a4: var(--gray-a4); --grayscale-a5: var(--gray-a5); --grayscale-a6: var(--gray-a6); --grayscale-a7: var(--gray-a7); --grayscale-a8: var(--gray-a8); --grayscale-a9: var(--gray-a9); --grayscale-a10: var(--gray-a10); --grayscale-a11: var(--gray-a11); --grayscale-a12: var(--gray-a12); --accent-1: #1e1e1e; --accent-2: #252525; --accent-3: #2d2d2d; --accent-4: #343434; --accent-5: #3b3b3b; --accent-6: #454545; --accent-7: #525252; --accent-8: #686868; --accent-9: #e0e0e0; --accent-10: #d6d6d6; --accent-11: #bababa; --accent-12: #e7e7e7; --accent-a1: #00000000; --accent-a2: #ffffff08; --accent-a3: #ffffff11; --accent-a4: #ffffff19; --accent-a5: #ffffff21; --accent-a6: #ffffff2c; --accent-a7: #ffffff3b; --accent-a8: #ffffff54; --accent-a9: #ffffffdc; --accent-a10: #ffffffd1; --accent-a11: #ffffffb1; --accent-a12: #ffffffe4; --accent-surface: color(display-p3 0.1725 0.1725 0.1725 / 0.5); --gray-surface: color(display-p3 0 0 0 / 5%); --accent: 224, 224, 224; --accent-aa: 224, 224, 224; --accent-aaa: 224, 224, 224; --accent-tinted: 237, 237, 237; --background: 30, 30, 30; --accent-contrast: rgb(49, 25, 33); --bg-color-card: rgba(25, 25, 25, 0.5); --bg-color-card-solid: rgb(27, 27, 27); --sidebar-background: rgb(8, 9, 10); --header-background: rgb(8, 9, 10); --border: var(--grayscale-a4); --border-concealed: var(--grayscale-a2); --body-text: 255, 255, 255; --body-text-inverted: 0, 0, 0; } html { background-color: #ffffff; } html.dark { background-color: #1e1e1e; } /* Hide branding */ .mx-auto.my-8.w-fit { display: none !important; } /* Hide first HR in changelog */ .fern-changelog > main > section + hr { display: none; } /* Make changelog entries center aligned */ .fern-changelog > main { margin-left: auto !important; margin-right: auto !important; overflow-wrap: break-word; width: 100%; } .fern-changelog-entry { justify-content: center !important; } /* Reduce padding on first changelog entry */ .fern-changelog > main > section.fern-changelog-entry { padding-bottom: 0px; } /* Hide the docs sidebar tab icons container */ .flex.min-w-0.items-center.justify-start.space-x-4 > .min-w-fit { display: none !important; position: absolute !important; visibility: hidden !important; } .flex.min-w-0.items-center.justify-start.space-x-4 > span { margin-left: 0 !important; } /* Fix the tablist not being scrollable on mobile and hide the native scrollbar */ [role='tablist'] { position: relative; overflow-x: auto; overflow-y: visible; /* Hide native scrollbars */ -ms-overflow-style: none; scrollbar-width: none; } [role='tablist']::-webkit-scrollbar { display: none; /* Chrome, Safari, newer Edge */ } [role='tablist'] h6[data-state='active'] { position: relative; z-index: 1; border-bottom: 2px solid currentColor !important; } /*---------------------------------------- Wave Animation Block ----------------------------------------*/ /* Overview Wave */ #overview-wave { width: 100vw; overflow: hidden !important; overflow-x: hidden !important; height: 350px; margin-left: 50%; transform: translateX(-50%); } #overview-wave canvas[data-engine='three.js r171'] { height: 350px !important; } .light-mode-wave { display: none; } .dark-mode-wave { display: none; } :root[class='light'] .light-mode-wave { display: block; } :root[class='dark'] .dark-mode-wave { display: block; } .fern-sidebar-heading-content { font-size: 0.75rem !important; line-height: 1rem !important; } @media (min-width: 1024px) { elevenlabs-convai { display: block; } .fern-sidebar-heading { min-height: 30px !important; } } /* Make active sidebar links bolder with transition */ .fern-sidebar-link-container .fern-sidebar-link-text { font-weight: 400; transition: font-weight 0.15s ease; } /* Active state styling */ :root[class='light'] .fern-sidebar-link-container[data-state='active'] .fern-sidebar-link-text { font-weight: 500; color: #000000; /* or your preferred light mode active color */ } :root[class='dark'] .fern-sidebar-link-container[data-state='active'] .fern-sidebar-link-text { font-weight: 500; color: #ffffff; /* or your preferred dark mode active color */ } :root[class='light'] { --wave-color: blue; } :root[class='dark'] { --wave-color: gray; } /* Sidebar, header and header tabs styling */ .clipped-background { background: none !important; opacity: 0 !important; } .fern-header, .fern-header-tabs { background-color: rgba(255, 255, 255, 0) !important; } .fern-sidebar-container, .fern-header-container { backdrop-filter: blur(10px); } .fern-header-container { border-bottom-color: rgb(233, 232, 234); border-bottom-style: solid; border-bottom-width: 1px; box-sizing: border-box; } :root[class='light'] .fern-sidebar-container, :root[class='light'] .fern-header-container { background-color: rgba(255, 255, 255, 0.9) !important; border-color: #e9e8ea !important; } :root[class='dark'] .fern-sidebar-container, :root[class='dark'] .fern-header-container { border-color: #23252a !important; background-color: rgba(0, 0, 0, 0.8); } /* Remove the bottom border on the header */ .fern-header { border-bottom: none !important; } /* Fix the logo height */ .fern-logo-container { height: 30px !important; } /* Bring TOC infront of the wave */ .fern-layout-toc { z-index: 1 !important; } </style><style id="__jsx-1095366776">:root{ --header-offset: 94px}@media(max-width:1024px){:root{--header-offset:50px}}</style></head><body class="antialiased"><div id="__next"><div class="fern-background dark:from-transparent"></div><div id="fern-docs" class="fern-container fern-theme-default"><header id="fern-header" role="banner"><div class="fern-header-container width-before-scroll-bar has-background-light has-background-dark" data-border="hide"><div class="clipped-background"><div class="h-screen opacity-60 dark:opacity-80 fern-background dark:from-transparent"></div></div><div class="fern-header"><nav aria-label="primary" class="fern-header-content max-w-page-width mx-auto"><div class="relative flex h-full min-w-fit flex-1 shrink-0 items-center gap-2 py-1"><div class="flex items-center gap-2"><a href="/docs"><div class="fern-logo-container"><img alt="ElevenLabs Documentation" fetchpriority="high" loading="eager" width="742" height="192" decoding="async" data-nimg="1" class="fern-logo-light" style="color:transparent;aspect-ratio:3.8645833333333335;height:30px;width:auto" src="https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-light.svg"/><img alt="ElevenLabs Documentation" fetchpriority="high" loading="eager" width="742" height="192" decoding="async" data-nimg="1" class="fern-logo-dark" style="color:transparent;aspect-ratio:3.8645833333333335;height:30px;width:auto" src="https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-dark.svg"/></div></a></div></div><div class="fern-header-searchbar"><button class="inline-flex h-9 w-full cursor-text items-center justify-start gap-2 whitespace-nowrap rounded-md p-2 text-sm font-medium transition-colors hover:transition-none focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-[var(--accent-6)] disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0 cursor-default bg-[var(--grayscale-a3)] text-[var(--grayscale-a10)]"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-search"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg>Search<span class="inline-flex gap-1 ml-auto"><kbd class="fern-kbd">/</kbd></span></button></div><div class="fern-header-right-menu flex-1"><div class="lg-menu"><span class="fern-button-group"><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button minimal normal" target="_blank" rel="noreferrer" href="https://discord.gg/elevenlabs"><span class="fern-button-content"><span class="fern-button-text">Community</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button minimal normal" href="https://elevenlabs.io/blog"><span class="fern-button-content"><span class="fern-button-text">Blog</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button minimal normal" target="_blank" rel="noreferrer" href="https://help.elevenlabs.io/"><span class="fern-button-content"><span class="fern-button-text">Help Center</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button filled normal primary" href="https://elevenlabs.io/sign-up"><span class="fern-button-content"><span class="fern-button-text">Sign up</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon transition-transform group-hover:translate-x-0.5"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R9t4um:" class="fern-theme-button fern-button minimal normal primary rounded square"><span class="fern-button-content"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button></span></div><div class="max-lg-menu"><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:Rat4um:" class="fern-theme-button fern-button minimal large primary rounded square"><span class="fern-button-content"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button><button tabindex="0" disabled="" data-state="off" aria-disabled="true" data-selected="false" id="fern-search-button" class="max-sm:block fern-button minimal large disabled rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon-md"><path d="M17 17L21 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 11C3 15.4183 6.58172 19 11 19C13.213 19 15.2161 18.1015 16.6644 16.6493C18.1077 15.2022 19 13.2053 19 11C19 6.58172 15.4183 3 11 3C6.58172 3 3 6.58172 3 11Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button><button tabindex="0" data-state="off" aria-disabled="false" class="fern-button minimal large rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon-md"><path d="M3 5H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 12H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 19H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></nav></div><nav aria-label="tabs" class="fern-header-tabs"><ul class="fern-header-tabs-list"><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/docs/overview"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="truncate font-medium">Docs</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/docs/conversational-ai/overview"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="truncate font-medium">Conversational AI</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="active" href="/docs/api-reference/introduction"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="truncate font-medium">API reference</span></div></a></li></ul></nav></div></header><style> .fern-sidebar-container { border-right-width: 1px; border-left-width: 1px; } :is(.dark) .fern-sidebar-container { border-right-width: 1px; border-left-width: 1px; } </style><div class="fern-body"><nav aria-label="secondary" class="fern-sidebar-container desktop fern-sidebar-fixed"><div dir="ltr" class="fern-scroll-area flex-1" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport group/sidebar fern-sidebar-content" data-scrollbars="vertical" style="overflow-x:hidden;overflow-y:hidden"><div style="min-width:100%;display:table"><ul class="fern-sidebar-tabs lg:hidden"><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/docs/overview"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">Docs</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/docs/conversational-ai/overview"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">Conversational AI</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="active" href="/docs/api-reference/introduction"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/book-open.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">API reference</span></div></a></li></ul><ul class="fern-sidebar-group"><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">API REFERENCE</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="active"><a class="fern-sidebar-link" href="/docs/api-reference/introduction"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Introduction</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/docs/api-reference/authentication"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Authentication</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/docs/api-reference/streaming"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Streaming</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/docs/api-reference/websocket"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Websocket</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">ENDPOINTS</span></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Text to Speech</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Voice changer</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Sound effects</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Audio Isolation</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Text to Voice</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Dubbing</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">ADMINISTRATION</span></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Audio Native</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">History</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Models</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Studio</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Pronunciation Dictionary</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Samples</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Usage</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">User</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Voice Library</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Voices</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Workspace</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">CONVERSATIONAL AI</span></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Agents</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Conversations</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Knowledge Base</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Tools</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Phone Numbers</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Widget</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">LEGACY</span></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Voice Generation (Deprecated)</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">projects</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li></ul><div class="border-concealed -mx-4 mt-4 list-none border-t p-4 lg:hidden"><a tabindex="0" aria-disabled="false" data-state="off" class="w-full fern-button minimal normal" target="_blank" rel="noreferrer" href="https://discord.gg/elevenlabs"><span class="fern-button-content"><span class="fern-button-text">Community</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full fern-button minimal normal" href="https://elevenlabs.io/blog"><span class="fern-button-content"><span class="fern-button-text">Blog</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full fern-button minimal normal" target="_blank" rel="noreferrer" href="https://help.elevenlabs.io/"><span class="fern-button-content"><span class="fern-button-text">Help Center</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full mt-2 fern-button filled normal primary" href="https://elevenlabs.io/sign-up"><span class="fern-button-content"><span class="fern-button-text">Sign up</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div></div></div></div></nav><div class="fern-main"><div class="scroll-mt-content" id="/docs/api-reference/introduction"><main class="fern-guide-layout"><aside class="fern-layout-toc"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport px-4 pb-12 pt-8 lg:pr-8" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden"><div style="min-width:100%;display:table"><div class="text-grayscale-a11 m-0 mb-3 text-sm font-medium">On this page</div><ul class="toc-root not-prose" style="--height:0px;--top:0px"><li class="mb-2 last:mb-0" data-depth="0"><a class="block hyphens-auto break-words text-sm transition-colors hover:transition-none text-grayscale-a11 hover:text-grayscale-a12" style="padding-left:0px" href="/docs/api-reference/introduction#installation">Installation</a></li></ul></div></div></div></aside><article class="fern-layout-content max-w-content-width"><header class="mb-8"><div class="space-y-1"><div><span class="fern-breadcrumb"><a class="fern-breadcrumb-item" href="/docs/api-reference/introduction">API REFERENCE</a></span></div><h1 class="fern-page-heading"><p>Introduction</p></h1></div><div class="prose-p:t-muted mt-2 leading-7"><p>Welcome to the ElevenLabs API reference.</p></div></header><div class="prose dark:prose-invert prose-h1:mt-[1.5em] first:prose-h1:mt-0 max-w-full break-words"><h2 id="installation" data-state="closed">Installation</h2> <p>You can interact with the API through HTTP or Websocket requests from any language, via our official Python bindings or our official Node.js libraries.</p> <p>To install the official Python bindings, run the following command:</p> <div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">pip install elevenlabs</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div> <p>To install the official Node.js library, run the following command in your Node.js project directory:</p> <div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">npm install elevenlabs</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div> <div id="overview-wave"><div class="h-400 relative w-full h-[500px]"></div></div></div><footer class="mt-12"><div class="flex gap-4 max-sm:flex-col sm:justify-between"><div></div><a tabindex="0" aria-disabled="false" data-state="off" class="fern-button outlined normal" target="_blank" rel="noreferrer" href="https://github.com/elevenlabs/elevenlabs-docs/blob/main/fern/api-reference/pages/introduction.mdx?plain=1"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M3 21L12 21H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.2218 5.82839L15.0503 2.99996L20 7.94971L17.1716 10.7781M12.2218 5.82839L6.61522 11.435C6.42769 11.6225 6.32233 11.8769 6.32233 12.1421L6.32233 16.6776L10.8579 16.6776C11.1231 16.6776 11.3774 16.5723 11.565 16.3847L17.1716 10.7781M12.2218 5.82839L17.1716 10.7781" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">Edit this page</span></span></a></div></footer></article></main><div class="fern-endpoint-content"><div class=""></div></div></div><div class="h-full"></div><div class="pb-36"></div><style> #builtwithfern { display: flex !important; opacity: 100% !important; } #builtwithfern * { display: initial !important; width: unset !important; opacity: 100% !important; } #builtwithfern, #builtwithfern * { visibility: initial !important; overflow: visible !important; position: relative !important; left: unset !important; top: unset !important; right: unset !important; bottom: unset !important; inset: unset !important; }</style><a id="builtwithfern" class="mx-auto flex items-baseline gap-1 mx-auto my-8 w-fit" href="https://buildwithfern.com/?utm_campaign=buildWith&utm_medium=docs&utm_source=elevenlabs.io" data-state="closed"><span class="t-muted whitespace-nowrap text-xs">Built with</span><svg viewBox="0 0 604 164" fill="none" xmlns="http://www.w3.org/2000/svg" class="transition" style="aspect-ratio:604/164;height:14px;margin-top:-2px"><path fill-rule="evenodd" clip-rule="evenodd" d="M295.294 0H255.861H255.836C234.047 0 221.437 11.4661 221.437 33.483V47.2372H193.242V75.2033H221.437V160.5H253.547V75.2033H288.404V47.2372H253.547V37.3728C253.547 30.7118 257.208 27.9661 263.87 27.9661H295.294V0ZM345.26 43.8081C311.777 43.8081 288.844 67.1979 288.844 103.198H288.87C288.87 139.884 311.802 163.96 346.43 163.96C375.311 163.96 392.727 149.291 399.388 126.816H366.591C363.591 133.02 356.955 137.367 346.633 137.367C331.277 137.367 321.87 129.562 320.497 115.35H400.761C401.219 110.545 401.447 106.401 401.447 102.283C401.447 66.2826 378.744 43.8081 345.26 43.8081ZM369.108 90.5877V91.0453H320.269C321.184 77.7487 329.675 69.0284 345.26 69.0284C360.845 69.0284 369.108 77.7487 369.108 90.5877ZM412.668 47.2321H440.863V67.1898C443.609 54.3508 452.787 47.2321 467.227 47.2321H487.414V51.122C487.414 64.4186 476.634 75.1982 463.338 75.1982C450.727 75.1982 444.753 81.6304 444.753 94.4694V160.52H412.642V47.2321H412.668ZM526.939 47.24H498.744H498.719V160.503H530.829V96.0789C530.829 81.6382 539.321 72.6891 552.16 72.6891C564.999 72.6891 571.889 80.0366 571.889 95.1637V160.528H604V91.7315C604 61.7061 586.559 43.8078 558.821 43.8078C545.753 43.8078 533.601 48.8417 526.939 58.7061V47.24Z" class="fill-grayscale-a10"></path><path d="M149.383 80.2222C138.594 71.101 122.341 67.4445 107.936 78.0925C107.273 78.5747 106.449 77.751 106.952 77.1081C110.367 72.7082 114.325 67.9668 117.519 63.2053C120.774 58.3233 125.636 54.8275 131.241 53.1198C161.076 44.079 152.116 0 152.116 0C152.116 0 106.027 2.97342 111.713 42.7329C112.657 49.3829 110.889 56.1535 106.731 61.4374C101.628 67.8865 95.7008 74.0543 91.4014 78.5144C90.4973 79.4386 88.9705 78.5546 89.3321 77.309C93.4909 63.3058 96.5246 41.648 82.1195 27.685L61.848 10.849L57.9504 15.9922C46.3581 31.2812 49.7534 52.8385 65.0625 64.4108C73.8422 71.0407 77.8201 78.2533 77.1973 86.169C76.8156 90.9104 74.6659 95.3505 71.4514 98.8663C65.4041 105.496 59.7586 112.608 55.3989 120.846C54.7962 121.991 53.0483 121.549 53.1086 120.243C53.7314 106.641 52.4255 75.983 29.5221 65.0336L3.88635 55.1289L1.89737 61.0556C-4.55174 80.182 5.99588 100.614 25.1021 107.104C41.7171 112.749 47.6439 123.457 43.6458 139.51C43.465 140.092 40.572 156.627 40.9738 163.96H59.3969C60.0198 152.589 71.9536 145.115 82.3003 149.756C85.2135 151.062 88.207 152.93 91.2809 155.341C107.755 168.32 132.025 165.246 144.983 148.752L148.68 144.05L125.375 127.315C109.383 114.738 88.0463 120.424 72.255 131.192C70.929 132.096 69.2414 130.65 69.9847 129.203C89.0709 91.7542 113.883 91.8346 123.607 100.152C135.4 110.238 153.261 108.429 163.266 96.5961L166.139 93.2007L149.363 80.2222H149.383Z" class="fill-grayscale-a10"></path></svg></a></div></div><footer id="fern-footer"></footer></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"baseUrl":{"domain":"elevenlabs.io","basePath":"/docs"},"layout":{"pageWidth":{"type":"full"},"sidebarWidth":{"type":"px","value":240},"headerHeight":{"type":"px","value":50},"searchbarPlacement":"HEADER","tabsPlacement":"HEADER","contentAlignment":"CENTER","headerPosition":"FIXED","disableHeader":false},"title":"ElevenLabs Documentation","favicon":"afbf04d1-513a-434f-95e2-5b32f1079129","colors":{"light":{"accentPrimary":{"r":64,"g":64,"b":64,"a":1},"logo":"cd6de17d-a981-4239-8366-7f61ab7e9eb7","background":{"type":"solid","r":255,"g":255,"b":255,"a":1},"sidebarBackground":{"r":255,"g":255,"b":255,"a":1},"headerBackground":{"r":255,"g":255,"b":255,"a":1}},"dark":{"accentPrimary":{"r":224,"g":224,"b":224,"a":1},"logo":"8b01c7d8-7e4b-4465-8a57-c0bc386f15a1","background":{"type":"solid","r":30,"g":30,"b":30,"a":1},"sidebarBackground":{"r":8,"g":9,"b":10,"a":1},"headerBackground":{"r":8,"g":9,"b":10,"a":1}}},"js":{"remote":[{"strategy":"lazyOnload","url":"https://elevenlabs.io/player/audioNativeHelper.js"},{"url":"https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/scripts/widget.js","strategy":"lazyOnload"},{"url":"https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/scripts/audio-player.js","strategy":"lazyOnload"}]},"navbarLinks":[{"type":"minimal","href":"https://discord.gg/elevenlabs","text":"Community"},{"type":"minimal","href":"https://elevenlabs.io/blog","text":"Blog"},{"type":"minimal","href":"https://help.elevenlabs.io/","text":"Help Center"},{"type":"filled","href":"https://elevenlabs.io/sign-up","text":"Sign up","rounded":false}],"logo":{"height":30,"href":"/docs","light":{"src":"https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-light.svg","width":742,"height":192},"dark":{"src":"https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/logo-dark.svg","width":742,"height":192}},"content":{"type":"api-reference-page","slug":"docs/api-reference/introduction","apiReferenceNodeId":"92e5ea5a268b267968ab9485c9b7dd9bf2ee1161494ba1dfd955987aecfd6d3d","apiDefinition":{"id":"b3a79396-26a1-4552-813c-956902d5a173","endpoints":{},"websockets":{},"webhooks":{},"types":{},"globalHeaders":[],"auths":{"default":{"type":"header","headerWireValue":"xi-api-key","nameOverride":"apiKey"}},"subpackages":{}},"mdxs":{"d5a960f49f5c30fd6af497cdd7eaac6f0d42fe8a683b7043d2a0a3602e6a31f1":{"slug":"docs/api-reference/introduction","title":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var m=Object.create;var r=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var M=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,l=Object.prototype.hasOwnProperty;var C=(n,e)=\u003e()=\u003e(e||n((e={exports:{}}).exports,e),e.exports),D=(n,e)=\u003e{for(var t in e)r(n,t,{get:e[t],enumerable:!0})},d=(n,e,t,u)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let o of M(e))!l.call(n,o)\u0026\u0026o!==t\u0026\u0026r(n,o,{get:()=\u003ee[o],enumerable:!(u=x(e,o))||u.enumerable});return n};var X=(n,e,t)=\u003e(t=n!=null?m(_(n)):{},d(e||!n||!n.__esModule?r(t,\"default\",{value:n,enumerable:!0}):t,n)),h=n=\u003ed(r({},\"__esModule\",{value:!0}),n);var p=C((b,i)=\u003e{i.exports=_jsx_runtime});var v={};D(v,{default:()=\u003ef,frontmatter:()=\u003ej});var s=X(p());var{useMDXComponents:c}=MdxJsReact;var j=void 0;function a(n){let e={p:\"p\",...c(),...n.components};return(0,s.jsx)(e.p,{children:\"Introduction\"})}function f(n={}){let{wrapper:e}={...c(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(a,{...n})}):a(n)}return h(v);})();\n;return Component;","frontmatter":{},"scope":{},"jsxRefs":[]},"subtitle":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var p=Object.create;var r=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var M=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var C=(e,n)=\u003e()=\u003e(n||e((n={exports:{}}).exports,n),n.exports),h=(e,n)=\u003e{for(var t in n)r(e,t,{get:n[t],enumerable:!0})},d=(e,n,t,u)=\u003e{if(n\u0026\u0026typeof n==\"object\"||typeof n==\"function\")for(let o of l(n))!_.call(e,o)\u0026\u0026o!==t\u0026\u0026r(e,o,{get:()=\u003en[o],enumerable:!(u=x(n,o))||u.enumerable});return e};var D=(e,n,t)=\u003e(t=e!=null?p(M(e)):{},d(n||!e||!e.__esModule?r(t,\"default\",{value:e,enumerable:!0}):t,e)),X=e=\u003ed(r({},\"__esModule\",{value:!0}),e);var a=C((A,i)=\u003e{i.exports=_jsx_runtime});var v={};h(v,{default:()=\u003em,frontmatter:()=\u003ej});var s=D(a());var{useMDXComponents:c}=MdxJsReact;var j=void 0;function f(e){let n={p:\"p\",...c(),...e.components};return(0,s.jsx)(n.p,{children:\"Welcome to the ElevenLabs API reference.\"})}function m(e={}){let{wrapper:n}={...c(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}return X(v);})();\n;return Component;","frontmatter":{},"scope":{},"jsxRefs":[]},"tableOfContents":[{"simpleString":"Installation","anchorString":"installation","children":[]}],"content":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var g=Object.create;var a=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,x=Object.prototype.hasOwnProperty;var v=(n,e)=\u003e()=\u003e(e||n((e={exports:{}}).exports,e),e.exports),y=(n,e)=\u003e{for(var o in e)a(n,o,{get:e[o],enumerable:!0})},l=(n,e,o,i)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let r of p(e))!x.call(n,r)\u0026\u0026r!==o\u0026\u0026a(n,r,{get:()=\u003ee[r],enumerable:!(i=m(e,r))||i.enumerable});return n};var j=(n,e,o)=\u003e(o=n!=null?g(b(n)):{},l(e||!n||!n.__esModule?a(o,\"default\",{value:n,enumerable:!0}):o,n)),w=n=\u003el(a({},\"__esModule\",{value:!0}),n);var h=v((M,c)=\u003e{c.exports=_jsx_runtime});var _={};y(_,{default:()=\u003ef,frontmatter:()=\u003eL});var t=j(h());var{useMDXComponents:s}=MdxJsReact;var L={title:\"Introduction\",subtitle:\"Welcome to the ElevenLabs API reference.\",\"hide-feedback\":!0};function d(n){let e={h2:\"h2\",p:\"p\",...s(),...n.components},{CodeBlock:o,ElevenLabsWaveform:i}=e;return o||u(\"CodeBlock\",!0),i||u(\"ElevenLabsWaveform\",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:\"installation\",children:\"Installation\"}),`\n`,(0,t.jsx)(e.p,{children:\"You can interact with the API through HTTP or Websocket requests from any language, via our official Python bindings or our official Node.js libraries.\"}),`\n`,(0,t.jsx)(e.p,{children:\"To install the official Python bindings, run the following command:\"}),`\n`,(0,t.jsx)(o,{code:`pip install elevenlabs\n`,language:\"bash\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,t.jsx)(e.p,{children:\"To install the official Node.js library, run the following command in your Node.js project directory:\"}),`\n`,(0,t.jsx)(o,{code:`npm install elevenlabs\n`,language:\"bash\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,t.jsx)(\"div\",{id:\"overview-wave\",children:(0,t.jsx)(i,{color:\"gray\",className:\"h-[500px]\"})})]})}function f(n={}){let{wrapper:e}={...s(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}function u(n,e){throw new Error(\"Expected \"+(e?\"component\":\"object\")+\" `\"+n+\"` to be defined: you likely forgot to import, pass, or provide it.\")}return w(_);})();\n;return Component;","frontmatter":{"title":"Introduction","subtitle":"Welcome to the ElevenLabs API reference.","hide-feedback":true,"edit-this-page-url":"https://github.com/elevenlabs/elevenlabs-docs/blob/main/fern/api-reference/pages/introduction.mdx?plain=1"},"scope":{},"jsxRefs":["ElevenLabsWaveform"]},"breadcrumb":[{"title":"API REFERENCE","pointsTo":"docs/api-reference/introduction"}],"neighbors":{"prev":null,"next":null},"hasAside":false},"486577d350315b3adf2f6ad97c205109d25d1c40b6e863f0e5216e60dcb8b65d":{"slug":"docs/api-reference/authentication","title":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var m=Object.create;var s=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var M=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,l=Object.prototype.hasOwnProperty;var C=(n,e)=\u003e()=\u003e(e||n((e={exports:{}}).exports,e),e.exports),h=(n,e)=\u003e{for(var t in e)s(n,t,{get:e[t],enumerable:!0})},u=(n,e,t,i)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let o of M(e))!l.call(n,o)\u0026\u0026o!==t\u0026\u0026s(n,o,{get:()=\u003ee[o],enumerable:!(i=x(e,o))||i.enumerable});return n};var D=(n,e,t)=\u003e(t=n!=null?m(_(n)):{},u(e||!n||!n.__esModule?s(t,\"default\",{value:n,enumerable:!0}):t,n)),X=n=\u003eu(s({},\"__esModule\",{value:!0}),n);var a=C((b,d)=\u003e{d.exports=_jsx_runtime});var v={};h(v,{default:()=\u003ef,frontmatter:()=\u003ej});var r=D(a());var{useMDXComponents:c}=MdxJsReact;var j=void 0;function p(n){let e={p:\"p\",...c(),...n.components};return(0,r.jsx)(e.p,{children:\"Authentication\"})}function f(n={}){let{wrapper:e}={...c(),...n.components};return e?(0,r.jsx)(e,{...n,children:(0,r.jsx)(p,{...n})}):p(n)}return X(v);})();\n;return Component;","frontmatter":{},"scope":{},"jsxRefs":[]},"tableOfContents":[{"simpleString":"API Keys","anchorString":"api-keys","children":[{"simpleString":"Making requests","anchorString":"making-requests","children":[]}]}],"content":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var g=Object.create;var r=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var y=Object.getPrototypeOf,f=Object.prototype.hasOwnProperty;var E=(t,e)=\u003e()=\u003e(e||t((e={exports:{}}).exports,e),e.exports),L=(t,e)=\u003e{for(var i in e)r(t,i,{get:e[i],enumerable:!0})},l=(t,e,i,a)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let o of m(e))!f.call(t,o)\u0026\u0026o!==i\u0026\u0026r(t,o,{get:()=\u003ee[o],enumerable:!(a=p(e,o))||a.enumerable});return t};var x=(t,e,i)=\u003e(i=t!=null?g(y(t)):{},l(e||!t||!t.__esModule?r(i,\"default\",{value:t,enumerable:!0}):i,t)),A=t=\u003el(r({},\"__esModule\",{value:!0}),t);var h=E((I,c)=\u003e{c.exports=_jsx_runtime});var P={};L(P,{default:()=\u003eu,frontmatter:()=\u003ek});var n=x(h());var{useMDXComponents:s}=MdxJsReact;var k={title:\"Authentication\",\"hide-feedback\":!0};function d(t){let e={code:\"code\",h2:\"h2\",h3:\"h3\",li:\"li\",ol:\"ol\",p:\"p\",strong:\"strong\",...s(),...t.components},{CodeBlock:i}=e;return i||b(\"CodeBlock\",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.h2,{id:\"api-keys\",children:\"API Keys\"}),`\n`,(0,n.jsx)(e.p,{children:\"The ElevenLabs API uses API keys for authentication. Every request to the API must include your API key, used to authenticate your requests and track usage quota.\"}),`\n`,(0,n.jsx)(e.p,{children:\"Each API key can be scoped to one of the following:\"}),`\n`,(0,n.jsxs)(e.ol,{children:[`\n`,(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:\"Scope restriction:\"}),\" Set access restrictions by limiting which API endpoints the key can access.\"]}),`\n`,(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:\"Credit quota:\"}),\" Define custom credit limits to control usage.\"]}),`\n`]}),`\n`,(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:\"Remember that your API key is a secret.\"}),\" Do not share it with others or expose it in any client-side code (browsers, apps).\"]}),`\n`,(0,n.jsxs)(e.p,{children:[\"All API requests should include your API key in an \",(0,n.jsx)(e.code,{children:\"xi-api-key\"}),\" HTTP header as follows:\"]}),`\n`,(0,n.jsx)(i,{code:`xi-api-key: ELEVENLABS_API_KEY\n`,language:\"bash\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,n.jsx)(e.h3,{id:\"making-requests\",children:\"Making requests\"}),`\n`,(0,n.jsxs)(e.p,{children:[\"You can paste the command below into your terminal to run your first API request. Make sure to replace \",(0,n.jsx)(e.code,{children:\"$ELEVENLABS_API_KEY\"}),\" with your secret API key.\"]}),`\n`,(0,n.jsx)(i,{code:`curl 'https://api.elevenlabs.io/v1/models' \\\\\n -H 'Content-Type: application/json' \\\\\n -H 'xi-api-key: $ELEVENLABS_API_KEY'\n`,language:\"bash\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,n.jsxs)(e.p,{children:[\"Example with the \",(0,n.jsx)(e.code,{children:\"elevenlabs\"}),\" Python package:\"]}),`\n`,(0,n.jsx)(i,{code:`from elevenlabs.client import ElevenLabs\n\nclient = ElevenLabs(\n api_key='YOUR_API_KEY',\n)\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,n.jsxs)(e.p,{children:[\"Example with the \",(0,n.jsx)(e.code,{children:\"elevenlabs\"}),\" Node.js package:\"]}),`\n`,(0,n.jsx)(i,{code:`import { ElevenLabsClient } from 'elevenlabs';\n\nconst client = new ElevenLabsClient({\n apiKey: 'YOUR_API_KEY',\n});\n`,language:\"javascript\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0})]})}function u(t={}){let{wrapper:e}={...s(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(d,{...t})}):d(t)}function b(t,e){throw new Error(\"Expected \"+(e?\"component\":\"object\")+\" `\"+t+\"` to be defined: you likely forgot to import, pass, or provide it.\")}return A(P);})();\n;return Component;","frontmatter":{"title":"Authentication","hide-feedback":true,"edit-this-page-url":"https://github.com/elevenlabs/elevenlabs-docs/blob/main/fern/api-reference/pages/authentication.mdx?plain=1"},"scope":{},"jsxRefs":[]},"breadcrumb":[{"title":"API REFERENCE","pointsTo":"docs/api-reference/introduction"}],"neighbors":{"prev":null,"next":null},"hasAside":false},"9ff2036ccf416a76819fd24651fe0991d4a8f010e2ca5e3fad7a6503c89efa2c":{"slug":"docs/api-reference/streaming","title":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var f=Object.create;var r=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var M=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,l=Object.prototype.hasOwnProperty;var C=(n,e)=\u003e()=\u003e(e||n((e={exports:{}}).exports,e),e.exports),D=(n,e)=\u003e{for(var t in e)r(n,t,{get:e[t],enumerable:!0})},u=(n,e,t,i)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let o of M(e))!l.call(n,o)\u0026\u0026o!==t\u0026\u0026r(n,o,{get:()=\u003ee[o],enumerable:!(i=x(e,o))||i.enumerable});return n};var X=(n,e,t)=\u003e(t=n!=null?f(_(n)):{},u(e||!n||!n.__esModule?r(t,\"default\",{value:n,enumerable:!0}):t,n)),h=n=\u003eu(r({},\"__esModule\",{value:!0}),n);var a=C((b,d)=\u003e{d.exports=_jsx_runtime});var g={};D(g,{default:()=\u003ep,frontmatter:()=\u003ej});var s=X(a());var{useMDXComponents:c}=MdxJsReact;var j=void 0;function m(n){let e={p:\"p\",...c(),...n.components};return(0,s.jsx)(e.p,{children:\"Streaming\"})}function p(n={}){let{wrapper:e}={...c(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(m,{...n})}):m(n)}return h(g);})();\n;return Component;","frontmatter":{},"scope":{},"jsxRefs":[]},"tableOfContents":[],"content":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var u=Object.create;var a=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var g=Object.getOwnPropertyNames;var f=Object.getPrototypeOf,b=Object.prototype.hasOwnProperty;var v=(n,e)=\u003e()=\u003e(e||n((e={exports:{}}).exports,e),e.exports),y=(n,e)=\u003e{for(var o in e)a(n,o,{get:e[o],enumerable:!0})},l=(n,e,o,r)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let i of g(e))!b.call(n,i)\u0026\u0026i!==o\u0026\u0026a(n,i,{get:()=\u003ee[i],enumerable:!(r=p(e,i))||r.enumerable});return n};var _=(n,e,o)=\u003e(o=n!=null?u(f(n)):{},l(e||!n||!n.__esModule?a(o,\"default\",{value:n,enumerable:!0}):o,n)),x=n=\u003el(a({},\"__esModule\",{value:!0}),n);var d=v((S,c)=\u003e{c.exports=_jsx_runtime});var C={};y(C,{default:()=\u003em,frontmatter:()=\u003ek});var t=_(d());var{useMDXComponents:s}=MdxJsReact;var k={title:\"Streaming\"};function h(n){let e={a:\"a\",p:\"p\",...s(),...n.components},{CodeBlock:o}=e;return o||w(\"CodeBlock\",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.p,{children:\"The ElevenLabs API supports real-time audio streaming for select endpoints, returning raw audio bytes (e.g., MP3 data) directly over HTTP using chunked transfer encoding. This allows clients to process or play audio incrementally as it is generated.\"}),`\n`,(0,t.jsxs)(e.p,{children:[\"Our official \",(0,t.jsx)(e.a,{href:\"https://github.com/elevenlabs/elevenlabs-js\",children:\"Node\"}),\" and \",(0,t.jsx)(e.a,{href:\"https://github.com/elevenlabs/elevenlabs-python\",children:\"Python\"}),\" libraries include utilities to simplify handling this continuous audio stream.\"]}),`\n`,(0,t.jsxs)(e.p,{children:[\"Streaming is supported for the \",(0,t.jsx)(e.a,{href:\"/docs/api-reference/streaming\",children:\"Text to Speech API\"}),\", \",(0,t.jsx)(e.a,{href:\"/docs/api-reference/speech-to-speech-streaming\",children:\"Voice Changer API\"}),\" \u0026 \",(0,t.jsx)(e.a,{href:\"/docs/api-reference/audio-isolation-stream\",children:\"Audio Isolation API\"}),\". This section focuses on how streaming works for requests made to the Text to Speech API.\"]}),`\n`,(0,t.jsx)(e.p,{children:\"In Python, a streaming request looks like:\"}),`\n`,(0,t.jsx)(o,{code:`from elevenlabs import stream\nfrom elevenlabs.client import ElevenLabs\n\nclient = ElevenLabs()\n\naudio_stream = client.text_to_speech.convert_as_stream(\n text=\"This is a test\",\n voice_id=\"JBFqnCBsd6RMkjVDRZzb\",\n model_id=\"eleven_multilingual_v2\"\n)\n\n#\\xA0option 1: play the streamed audio locally\nstream(audio_stream)\n\n#\\xA0option 2: process the audio bytes manually\nfor chunk in audio_stream:\n if isinstance(chunk, bytes):\n print(chunk)\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,t.jsx)(e.p,{children:\"In Node / Typescript, a streaming request looks like:\"}),`\n`,(0,t.jsx)(o,{code:`import { ElevenLabsClient, stream } from 'elevenlabs';\nimport { Readable } from 'stream';\n\nconst client = new ElevenLabsClient();\n\nasync function main() {\n const audioStream = await client.textToSpeech.convertAsStream('JBFqnCBsd6RMkjVDRZzb', {\n text: 'This is a test',\n model_id: 'eleven_multilingual_v2',\n });\n\n // option 1: play the streamed audio locally\n await stream(Readable.from(audioStream));\n\n // option 2: process the audio manually\n for await (const chunk of audioStream) {\n console.log(chunk);\n }\n}\n\nmain();\n`,language:\"javascript\",highlightLines:[],highlightStyle:\"highlight\",maxLines:0,wordWrap:!1,matchLanguage:!0})]})}function m(n={}){let{wrapper:e}={...s(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(h,{...n})}):h(n)}function w(n,e){throw new Error(\"Expected \"+(e?\"component\":\"object\")+\" `\"+n+\"` to be defined: you likely forgot to import, pass, or provide it.\")}return x(C);})();\n;return Component;","frontmatter":{"title":"Streaming","edit-this-page-url":"https://github.com/elevenlabs/elevenlabs-docs/blob/main/fern/api-reference/pages/streaming.mdx?plain=1"},"scope":{},"jsxRefs":[]},"breadcrumb":[{"title":"API REFERENCE","pointsTo":"docs/api-reference/introduction"}],"neighbors":{"prev":null,"next":null},"hasAside":false},"a4cd6a5e8af0f9acd3588d9d67010e611316836a1cb4426b0525658ff0993081":{"slug":"docs/api-reference/websocket","title":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var m=Object.create;var s=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var M=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,l=Object.prototype.hasOwnProperty;var C=(e,n)=\u003e()=\u003e(n||e((n={exports:{}}).exports,n),n.exports),D=(e,n)=\u003e{for(var t in n)s(e,t,{get:n[t],enumerable:!0})},d=(e,n,t,u)=\u003e{if(n\u0026\u0026typeof n==\"object\"||typeof n==\"function\")for(let o of M(n))!l.call(e,o)\u0026\u0026o!==t\u0026\u0026s(e,o,{get:()=\u003en[o],enumerable:!(u=x(n,o))||u.enumerable});return e};var X=(e,n,t)=\u003e(t=e!=null?m(_(e)):{},d(n||!e||!e.__esModule?s(t,\"default\",{value:e,enumerable:!0}):t,e)),h=e=\u003ed(s({},\"__esModule\",{value:!0}),e);var p=C((g,i)=\u003e{i.exports=_jsx_runtime});var b={};D(b,{default:()=\u003ef,frontmatter:()=\u003ej});var r=X(p());var{useMDXComponents:c}=MdxJsReact;var j=void 0;function a(e){let n={p:\"p\",...c(),...e.components};return(0,r.jsx)(n.p,{children:\"Websocket\"})}function f(e={}){let{wrapper:n}={...c(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}return h(b);})();\n;return Component;","frontmatter":{},"scope":{},"jsxRefs":[]},"tableOfContents":[{"simpleString":"When to use","anchorString":"when-to-use","children":[]},{"simpleString":"When not to use","anchorString":"when-not-to-use","children":[]},{"simpleString":"Protocol","anchorString":"protocol","children":[]},{"simpleString":"Streaming input text","anchorString":"streaming-input-text","children":[{"simpleString":"Close connection","anchorString":"close-connection","children":[]},{"simpleString":"Streaming output audio","anchorString":"streaming-output-audio","children":[]},{"simpleString":"Path parameters","anchorString":"path-parameters","children":[]},{"simpleString":"Query parameters","anchorString":"query-parameters","children":[]}]},{"simpleString":"Example - Voice streaming using ElevenLabs and OpenAI","anchorString":"example---voice-streaming-using-elevenlabs-and-openai","children":[]},{"simpleString":"Example - Other examples for interacting with our Websocket API","anchorString":"example---other-examples-for-interacting-with-our-websocket-api","children":[]},{"simpleString":"Example - Getting word start times using alignment values","anchorString":"example---getting-word-start-times-using-alignment-values","children":[]},{"simpleString":"Understanding how our websockets buffer text","anchorString":"understanding-how-our-websockets-buffer-text","children":[]}],"content":{"engine":"mdx-bundler","code":"var Component=(()=\u003e{var _=Object.create;var d=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var w=Object.getPrototypeOf,v=Object.prototype.hasOwnProperty;var x=(i,t)=\u003e()=\u003e(t||i((t={exports:{}}).exports,t),t.exports),k=(i,t)=\u003e{for(var a in t)d(i,a,{get:t[a],enumerable:!0})},u=(i,t,a,o)=\u003e{if(t\u0026\u0026typeof t==\"object\"||typeof t==\"function\")for(let s of b(t))!v.call(i,s)\u0026\u0026s!==a\u0026\u0026d(i,s,{get:()=\u003et[s],enumerable:!(o=y(t,s))||o.enumerable});return i};var I=(i,t,a)=\u003e(a=i!=null?_(w(i)):{},u(t||!i||!i.__esModule?d(a,\"default\",{value:i,enumerable:!0}):a,i)),S=i=\u003eu(d({},\"__esModule\",{value:!0}),i);var m=x((L,p)=\u003e{p.exports=_jsx_runtime});var A={};k(A,{default:()=\u003ef,frontmatter:()=\u003eT});var e=I(m());var{useMDXComponents:h}=MdxJsReact;var T={title:\"Websocket\",headline:\"Text to speech WebSocket API\"};function g(i){let t={a:\"a\",code:\"code\",h2:\"h2\",h3:\"h3\",li:\"li\",p:\"p\",table:\"table\",tbody:\"tbody\",td:\"td\",th:\"th\",thead:\"thead\",tr:\"tr\",ul:\"ul\",...h(),...i.components},{AccordionGroup:a,CodeBlock:o,CodeBlocks:s,FernErrorBoundary:l,Note:c,ParamField:n}=t;return a||r(\"AccordionGroup\",!0),o||r(\"CodeBlock\",!0),s||r(\"CodeBlocks\",!0),l||r(\"FernErrorBoundary\",!0),c||r(\"Note\",!0),n||r(\"ParamField\",!0),(0,e.jsxs)(e.Fragment,{children:[(0,e.jsxs)(t.p,{children:[\"This API provides real-time \",(0,e.jsx)(t.a,{href:\"https://elevenlabs.io/text-to-speech\",children:\"text-to-speech\"}),\" conversion using WebSockets. This allows you to send a text message and receive audio data back in real-time.\"]}),`\n`,(0,e.jsx)(t.h2,{id:\"when-to-use\",children:\"When to use\"}),`\n`,(0,e.jsx)(t.p,{children:\"The Text-to-Speech Websockets API is designed to generate audio from partial text input while ensuring consistency throughout the generated audio. Although highly flexible, the Websockets API isn\\u2019t a one-size-fits-all solution. It\\u2019s well-suited for scenarios where:\"}),`\n`,(0,e.jsxs)(t.ul,{children:[`\n`,(0,e.jsx)(t.li,{children:\"The input text is being streamed or generated in chunks.\"}),`\n`,(0,e.jsx)(t.li,{children:\"Word-to-audio alignment information is required.\"}),`\n`]}),`\n`,(0,e.jsxs)(t.p,{children:[\"For a practical demonstration of using ElevenLabs Text to Speech Websockets API, refer to the \",(0,e.jsx)(t.a,{href:\"/docs/cookbooks/text-to-speech/websockets\",children:\"Websockets Cookbook\"}),\".\"]}),`\n`,(0,e.jsx)(t.h2,{id:\"when-not-to-use\",children:\"When not to use\"}),`\n`,(0,e.jsx)(t.p,{children:\"However, it may not be the best choice when:\"}),`\n`,(0,e.jsxs)(t.ul,{children:[`\n`,(0,e.jsx)(t.li,{children:\"The entire input text is available upfront. Given that the generations are partial, some buffering is involved, which could potentially result in slightly higher latency compared to a standard HTTP request.\"}),`\n`,(0,e.jsx)(t.li,{children:\"You want to quickly experiment or prototype. Working with Websockets can be harder and more complex than using a standard HTTP API, which might slow down rapid development and testing.\"}),`\n`]}),`\n`,(0,e.jsxs)(t.p,{children:[\"In these cases, use the \",(0,e.jsx)(t.a,{href:\"/docs/api-reference/text-to-speech\",children:\"Text to Speech API\"}),\" instead.\"]}),`\n`,(0,e.jsx)(t.h2,{id:\"protocol\",children:\"Protocol\"}),`\n`,(0,e.jsx)(t.p,{children:\"The WebSocket API uses a bidirectional protocol that encodes all messages as JSON objects.\"}),`\n`,(0,e.jsx)(t.h2,{id:\"streaming-input-text\",children:\"Streaming input text\"}),`\n`,(0,e.jsx)(t.p,{children:\"The client can send messages with text input to the server. The messages can contain the following fields:\"}),`\n`,(0,e.jsx)(o,{code:`{\n \"text\": \"This is a sample text \",\n \"voice_settings\": {\n \"stability\": 0.8,\n \"similarity_boost\": 0.8\n },\n \"generation_config\": {\n \"chunk_length_schedule\": [120, 160, 250, 290]\n },\n \"xi_api_key\": \"\u003cXI API Key\u003e\",\n \"authorization\": \"Bearer \u003cAuthorization Token\u003e\"\n}\n`,language:\"json\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,e.jsx)(n,{path:\"text\",type:\"string\",required:!0,children:(0,e.jsxs)(t.p,{children:[\"Should always end with a single space string \",(0,e.jsx)(t.code,{children:'\" \"'}),`. In the first message, the text should be a\nspace `,(0,e.jsx)(t.code,{children:'\" \"'}),\".\"]})}),`\n`,(0,e.jsxs)(n,{path:\"try_trigger_generation\",type:\"boolean\",default:!1,deprecated:!0,children:[(0,e.jsxs)(t.p,{children:[\"This is an advanced setting that most users shouldn\\u2019t need to use. It relates to our generation schedule explained \",(0,e.jsx)(t.a,{href:\"#understanding-how-our-websockets-buffer-text\",children:\"here\"}),\".\"]}),(0,e.jsxs)(t.p,{children:[\"Use this to attempt to immediately trigger the generation of audio, overriding the \",(0,e.jsx)(t.code,{children:\"chunk_length_schedule\"}),\". Unlike flush, \",(0,e.jsx)(t.code,{children:\"try_trigger_generation\"}),\" will only generate audio if our \",(0,e.jsx)(t.a,{href:\"#understanding-how-our-websockets-buffer-text\",children:\"buffer\"}),\" contains more than a minimum threshold of characters, this is to ensure a higher quality response from our model.\"]}),(0,e.jsxs)(t.p,{children:[\"Note that overriding the chunk schedule to generate small amounts of text may result in lower quality audio, therefore, only use this parameter if you really need text to be processed immediately. We generally recommend keeping the default value of \",(0,e.jsx)(t.code,{children:\"false\"}),\" and adjusting the \",(0,e.jsx)(t.code,{children:\"chunk_length_schedule\"}),\" in the \",(0,e.jsx)(t.code,{children:\"generation_config\"}),\" instead.\"]})]}),`\n`,(0,e.jsxs)(n,{path:\"voice_settings\",type:\"object\",children:[(0,e.jsx)(t.p,{children:\"This property should only be provided in the first message you send.\"}),(0,e.jsx)(a,{items:[{title:\"properties\",id:\"properties\",children:(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(n,{path:\"stability\",type:\"number\",children:(0,e.jsx)(t.p,{children:\"Defines the stability for voice settings.\"})}),(0,e.jsx)(n,{path:\"similarity_boost\",type:\"number\",children:(0,e.jsx)(t.p,{children:\"Defines the similarity boost for voice settings.\"})}),(0,e.jsx)(n,{path:\"style\",type:\"number\",children:(0,e.jsx)(t.p,{children:\"Defines the style for voice settings. This parameter is available on V2+ models.\"})}),(0,e.jsx)(n,{path:\"use_speaker_boost\",type:\"boolean\",children:(0,e.jsx)(t.p,{children:\"Defines the use speaker boost for voice settings. This parameter is available on V2+ models.\"})})]})}]})]}),`\n`,(0,e.jsx)(\"a\",{id:\"chunk_length_schedule\"}),`\n`,(0,e.jsxs)(n,{path:\"generation_config\",type:\"object\",children:[(0,e.jsx)(t.p,{children:\"This property should only be provided in the first message you send.\"}),(0,e.jsx)(a,{items:[{title:\"properties\",defaultOpen:null,id:\"properties-1\",children:(0,e.jsx)(e.Fragment,{children:(0,e.jsxs)(n,{path:\"chunk_length_schedule\",type:\"array\",children:[(0,e.jsxs)(t.p,{children:[\"This is an advanced setting that most users shouldn\\u2019t need to use. It relates to our generation schedule explained \",(0,e.jsx)(t.a,{href:\"#understanding-how-our-websockets-buffer-text\",children:\"here\"}),\".\"]}),(0,e.jsx)(t.p,{children:\"Determines the minimum amount of text that needs to be sent and present in our buffer before audio starts being generated. This is to maximise the amount of context available to the model to improve audio quality, whilst balancing latency of the returned audio chunks.\"}),(0,e.jsx)(t.p,{children:\"The default value is: [120, 160, 250, 290].\"}),(0,e.jsx)(t.p,{children:\"This means that the first chunk of audio will not be generated until you send text that totals at least 120 characters long. The next chunk of audio will only be generated once a further 160 characters have been sent. The third audio chunk will be generated after the next 250 characters. Then the fourth, and beyond, will be generated in sets of at least 290 characters.\"}),(0,e.jsx)(t.p,{children:\"Customize this array to suit your needs. If you want to generate audio more frequently to optimise latency, you can reduce the values in the array. Note that setting the values too low may result in lower quality audio. Please test and adjust as needed.\"}),(0,e.jsx)(t.p,{children:\"Each item should be in the range 50-500.\"})]})})}]})]}),`\n`,(0,e.jsxs)(n,{path:\"flush\",type:\"boolean\",children:[(0,e.jsxs)(t.p,{children:[\"Flush forces the generation of audio. Set this value to \",(0,e.jsx)(t.code,{children:\"true\"}),\" when you have finished sending text, but want to keep the websocket connection open.\"]}),(0,e.jsxs)(t.p,{children:[\"This is useful when you want to ensure that the last chunk of audio is generated even when the length of text sent is smaller than the value set in \",(0,e.jsx)(t.code,{children:\"chunk_length_schedule\"}),\" (e.g. 120 or 50).\"]}),(0,e.jsxs)(t.p,{children:[\"To understand more about how our websockets buffer text before audio is generated, please refer to \",(0,e.jsx)(t.a,{href:\"#understanding-how-our-websockets-buffer-text\",children:\"this\"}),\" section.\"]})]}),`\n`,(0,e.jsx)(n,{path:\"xi_api_key\",type:\"string\",children:(0,e.jsx)(t.p,{children:\"Provide the XI API Key in the first message if it\\u2019s not in the header.\"})}),`\n`,(0,e.jsx)(n,{path:\"authorization\",type:\"string\",children:(0,e.jsx)(t.p,{children:`Authorization bearer token. Should be provided only in the first message if not present in the\nheader and the XI API Key is not provided.`})}),`\n`,(0,e.jsx)(c,{children:(0,e.jsx)(t.p,{children:`For best latency we recommend streaming word-by-word, this way we will start generating as soon as\nwe reach the predefined number of un-generated characters.`})}),`\n`,(0,e.jsx)(t.h3,{id:\"close-connection\",children:\"Close connection\"}),`\n`,(0,e.jsx)(t.p,{children:\"In order to close the connection, the client should send an End of Sequence (EOS) message. The EOS message should always be an empty string:\"}),`\n`,(0,e.jsx)(s,{items:[{code:`{\n \"text\": \"\"\n}\n`,language:\"json\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:void 0,title:\"End of Sequence (EOS) message\"}]}),`\n`,(0,e.jsx)(n,{path:\"text\",type:\"string\",required:!0,children:(0,e.jsxs)(t.p,{children:[\"Should always be an empty string \",(0,e.jsx)(t.code,{children:'\"\"'}),\".\"]})}),`\n`,(0,e.jsx)(t.h3,{id:\"streaming-output-audio\",children:\"Streaming output audio\"}),`\n`,(0,e.jsx)(t.p,{children:\"The server will always respond with a message containing the following fields:\"}),`\n`,(0,e.jsx)(s,{items:[{code:`{\n \"audio\": \"Y3VyaW91cyBtaW5kcyB0aGluayBhbGlrZSA6KQ==\",\n \"isFinal\": false,\n \"normalizedAlignment\": {\n \"charStartTimesMs\": [0, 3, 7, 9, 11, 12, 13, 15, 17, 19, 21],\n \"charDurationsMs\": [3, 4, 2, 2, 1, 1, 2, 2, 2, 2, 3],\n \"chars\": [\"H\", \"e\", \"l\", \"l\", \"o\", \" \", \"w\", \"o\", \"r\", \"l\", \"d\"]\n },\n \"alignment\": {\n \"charStartTimesMs\": [0, 3, 7, 9, 11, 12, 13, 15, 17, 19, 21],\n \"charDurationsMs\": [3, 4, 2, 2, 1, 1, 2, 2, 2, 2, 3],\n \"chars\": [\"H\", \"e\", \"l\", \"l\", \"o\", \" \", \"w\", \"o\", \"r\", \"l\", \"d\"]\n }\n}\n`,language:\"json\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:void 0,title:\"Response message\"}]}),`\n`,(0,e.jsx)(n,{path:\"audio\",type:\"string\",optional:\"true\",children:(0,e.jsx)(t.p,{children:`A generated partial audio chunk, encoded using the selected output_format, by default this is MP3\nencoded as a base64 string.`})}),`\n`,(0,e.jsx)(n,{path:\"isFinal\",type:\"boolean\",optional:\"true\",children:(0,e.jsxs)(t.p,{children:[\"Indicates if the generation is complete. If set to \",(0,e.jsx)(t.code,{children:\"True\"}),\", \",(0,e.jsx)(t.code,{children:\"audio\"}),\" will be null.\"]})}),`\n`,(0,e.jsxs)(n,{path:\"normalizedAlignment\",type:\"string\",optional:\"true\",children:[(0,e.jsx)(t.p,{children:\"Alignment information for the generated audio given the input normalized text sequence.\"}),(0,e.jsx)(a,{items:[{title:\"properties\",id:\"properties-2\",children:(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(l,{fallback:\"{' '}\",children:\" \"}),(0,e.jsx)(n,{path:\"char_start_times_ms\",type:\"array\",children:(0,e.jsxs)(t.p,{children:[`A list of starting times (in milliseconds) for each character in the normalized text as it\ncorresponds to the audio. For instance, the character \\u2018H\\u2019 starts at time 0 ms in the audio. Note\nthese times are relative to the returned chunk from the model, and not the full audio response.\nSee an example `,(0,e.jsx)(t.a,{href:\"#example-getting-word-start-times-using-alignment-values\",children:\"here\"}),` for how to use\nthis.`]})}),(0,e.jsx)(l,{fallback:\"{' '}\",children:\" \"}),(0,e.jsx)(n,{path:\"chars_durations_ms\",type:\"array\",children:(0,e.jsx)(t.p,{children:`A list providing the duration (in milliseconds) for each character\\u2019s pronunciation in the audio.\nFor instance, the character \\u2018H\\u2019 has a pronunciation duration of 3 ms.`})}),(0,e.jsx)(n,{path:\"chars\",type:\"array\",children:(0,e.jsx)(t.p,{children:\"The list of characters in the normalized text sequence that corresponds with the timings and durations. This list is used to map the characters to their respective starting times and durations.\"})})]})}]})]}),`\n`,(0,e.jsxs)(n,{path:\"alignment\",type:\"string\",optional:\"true\",children:[(0,e.jsx)(t.p,{children:\"Alignment information for the generated audio given the original text sequence.\"}),(0,e.jsx)(a,{items:[{title:\"properties\",id:\"properties-3\",children:(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(l,{fallback:\"{' '}\",children:\" \"}),(0,e.jsx)(n,{path:\"char_start_times_ms\",type:\"array\",children:(0,e.jsxs)(t.p,{children:[`A list of starting times (in milliseconds) for each character in the original text as it\ncorresponds to the audio. For instance, the character \\u2018H\\u2019 starts at time 0 ms in the audio. Note\nthese times are relative to the returned chunk from the model, and not the full audio response.\nSee an example `,(0,e.jsx)(t.a,{href:\"#example-getting-word-start-times-using-alignment-values\",children:\"here\"}),` for how to use\nthis.`]})}),(0,e.jsx)(l,{fallback:\"{' '}\",children:\" \"}),(0,e.jsx)(n,{path:\"chars_durations_ms\",type:\"array\",children:(0,e.jsx)(t.p,{children:`A list providing the duration (in milliseconds) for each character\\u2019s pronunciation in the audio.\nFor instance, the character \\u2018H\\u2019 has a pronunciation duration of 3 ms.`})}),(0,e.jsx)(n,{path:\"chars\",type:\"array\",children:(0,e.jsx)(t.p,{children:\"The list of characters in the original text sequence that corresponds with the timings and durations. This list is used to map the characters to their respective starting times and durations.\"})})]})}]})]}),`\n`,(0,e.jsx)(t.h3,{id:\"path-parameters\",children:\"Path parameters\"}),`\n`,(0,e.jsx)(n,{path:\"voice_id\",type:\"string\",children:(0,e.jsxs)(t.p,{children:[\"Voice ID to be used, you can use \",(0,e.jsx)(t.a,{href:\"/docs/api-reference/get-voices\",children:\"Get Voices\"}),` to list all the\navailable voices.`]})}),`\n`,(0,e.jsx)(t.h3,{id:\"query-parameters\",children:\"Query parameters\"}),`\n`,(0,e.jsx)(n,{query:\"model_id\",type:\"string\",children:(0,e.jsxs)(t.p,{children:[\"Identifier of the model that will be used, you can query them using \",(0,e.jsx)(t.a,{href:\"/docs/api-reference/get-models\",children:\"Get Models\"}),\".\"]})}),`\n`,(0,e.jsx)(n,{query:\"language_code\",type:\"string\",children:(0,e.jsx)(t.p,{children:\"Language code (ISO 639-1) used to enforce a language for the model. Currently only our v2.5 Flash \u0026 Turbo v2.5 models support language enforcement. For other models, an error will be returned if language code is provided.\"})}),`\n`,(0,e.jsx)(n,{query:\"enable_logging\",type:\"string\",children:(0,e.jsx)(t.p,{children:`Whether to enable request logging, if disabled the request will not be present in history nor bigtable.\nEnabled by default. Note: simple logging (aka printing) to stdout/stderr is always enabled.`})}),`\n`,(0,e.jsx)(n,{query:\"enable_ssml_parsing\",type:\"boolean\",children:(0,e.jsx)(t.p,{children:`Whether to enable/disable parsing of SSML tags within the provided text. For best results, we recommend\nsending SSML tags as fully contained messages to the websockets endpoint, otherwise this may result in additional latency.\nPlease note that rendered text, in normalizedAlignment, will be altered in support of SSML tags. The\nrendered text will use a . as a placeholder for breaks, and syllables will be reported using the CMU arpabet alphabet where SSML phoneme tags are used to specify pronunciation.\nDisabled by default.`})}),`\n`,(0,e.jsxs)(n,{query:\"optimize_streaming_latency\",type:\"string\",deprecated:!0,children:[(0,e.jsx)(t.p,{children:\"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values:\"}),(0,e.jsxs)(t.table,{children:[(0,e.jsx)(t.thead,{children:(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.th,{children:\"Value\"}),(0,e.jsx)(t.th,{children:\"Description\"})]})}),(0,e.jsxs)(t.tbody,{children:[(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"0\"}),(0,e.jsx)(t.td,{children:\"default mode (no latency optimizations)\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"1\"}),(0,e.jsx)(t.td,{children:\"normal latency optimizations (about 50% of possible latency improvement of option 3)\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"2\"}),(0,e.jsx)(t.td,{children:\"strong latency optimizations (about 75% of possible latency improvement of option 3)\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"3\"}),(0,e.jsx)(t.td,{children:\"max latency optimizations\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"4\"}),(0,e.jsx)(t.td,{children:\"max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).\"})]})]})]}),(0,e.jsxs)(t.p,{children:[\"Defaults to \",(0,e.jsx)(t.code,{children:\"0\"})]})]}),`\n`,(0,e.jsxs)(n,{query:\"output_format\",type:\"string\",children:[(0,e.jsx)(t.p,{children:\"Output format of the generated audio. Must be one of:\"}),(0,e.jsxs)(t.table,{children:[(0,e.jsx)(t.thead,{children:(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.th,{children:\"Value\"}),(0,e.jsx)(t.th,{children:\"Description\"})]})}),(0,e.jsxs)(t.tbody,{children:[(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"mp3_44100\"}),(0,e.jsx)(t.td,{children:\"default output format, mp3 with 44.1kHz sample rate\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"pcm_16000\"}),(0,e.jsx)(t.td,{children:\"PCM format (S16LE) with 16kHz sample rate\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"pcm_22050\"}),(0,e.jsx)(t.td,{children:\"PCM format (S16LE) with 22.05kHz sample rate\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"pcm_24000\"}),(0,e.jsx)(t.td,{children:\"PCM format (S16LE) with 24kHz sample rate\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"pcm_44100\"}),(0,e.jsx)(t.td,{children:\"PCM format (S16LE) with 44.1kHz sample rate\"})]}),(0,e.jsxs)(t.tr,{children:[(0,e.jsx)(t.td,{children:\"ulaw_8000\"}),(0,e.jsx)(t.td,{children:\"\\u03BC-law format (mulaw) with 8kHz sample rate. (Note that this format is commonly used for Twilio audio inputs.)\"})]})]})]}),(0,e.jsxs)(t.p,{children:[\"Defaults to \",(0,e.jsx)(t.code,{children:\"mp3_44100\"})]})]}),`\n`,(0,e.jsxs)(n,{query:\"inactivity_timeout\",type:\"number\",children:[(0,e.jsx)(t.p,{children:\"The number of seconds that the connection can be inactive before it is automatically closed.\"}),(0,e.jsxs)(t.p,{children:[\"Defaults to \",(0,e.jsx)(t.code,{children:\"20\"}),\" seconds, with a maximum allowed value of \",(0,e.jsx)(t.code,{children:\"180\"}),\" seconds.\"]})]}),`\n`,(0,e.jsx)(n,{query:\"sync_alignment\",type:\"boolean\",children:(0,e.jsx)(t.p,{children:`The audio for each text sequence is delivered in multiple chunks. By default when it\\u2019s set to\nfalse, you\\u2019ll receive all timing data (alignment information) with the first chunk only. However,\nif you enable this option, you\\u2019ll get the timing data with every audio chunk instead. This can\nhelp you precisely match each audio segment with its corresponding text.`})}),`\n`,(0,e.jsx)(n,{query:\"auto_mode\",type:\"boolean\",children:(0,e.jsx)(t.p,{children:`This parameter focuses on reducing the latency by disabling the chunk schedule and all buffers. It\nis only recommended when sending full sentences or phrases, sending partial phrases will result in\nhighly reduced quality. By default it\\u2019s set to false.`})}),`\n`,(0,e.jsx)(t.h2,{id:\"example---voice-streaming-using-elevenlabs-and-openai\",children:\"Example - Voice streaming using ElevenLabs and OpenAI\"}),`\n`,(0,e.jsx)(t.p,{children:\"The following example demonstrates how to leverage the ElevenLabs Websockets API to stream input from OpenAI\\u2019s GPT model, while the answer is being generated, thereby minimizing the overall latency of the operation.\"}),`\n`,(0,e.jsx)(o,{code:`import asyncio\nimport websockets\nimport json\nimport base64\nimport shutil\nimport os\nimport subprocess\nfrom openai import AsyncOpenAI\n\n# Define API keys and voice ID\nOPENAI_API_KEY = '\u003cOPENAI_API_KEY\u003e'\nELEVENLABS_API_KEY = '\u003cELEVENLABS_API_KEY\u003e'\nVOICE_ID = '21m00Tcm4TlvDq8ikWAM'\n\n# Set OpenAI API key\naclient = AsyncOpenAI(api_key=OPENAI_API_KEY)\n\ndef is_installed(lib_name):\n return shutil.which(lib_name) is not None\n\n\nasync def text_chunker(chunks):\n \"\"\"Split text into chunks, ensuring to not break sentences.\"\"\"\n splitters = (\".\", \",\", \"?\", \"!\", \";\", \":\", \"\\u2014\", \"-\", \"(\", \")\", \"[\", \"]\", \"}\", \" \")\n buffer = \"\"\n\n async for text in chunks:\n if buffer.endswith(splitters):\n yield buffer + \" \"\n buffer = text\n elif text.startswith(splitters):\n yield buffer + text[0] + \" \"\n buffer = text[1:]\n else:\n buffer += text\n\n if buffer:\n yield buffer + \" \"\n\n\nasync def stream(audio_stream):\n \"\"\"Stream audio data using mpv player.\"\"\"\n if not is_installed(\"mpv\"):\n raise ValueError(\n \"mpv not found, necessary to stream audio. \"\n \"Install instructions: https://mpv.io/installation/\"\n )\n\n mpv_process = subprocess.Popen(\n [\"mpv\", \"--no-cache\", \"--no-terminal\", \"--\", \"fd://0\"],\n stdin=subprocess.PIPE, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,\n )\n\n print(\"Started streaming audio\")\n async for chunk in audio_stream:\n if chunk:\n mpv_process.stdin.write(chunk)\n mpv_process.stdin.flush()\n\n if mpv_process.stdin:\n mpv_process.stdin.close()\n mpv_process.wait()\n\n\nasync def text_to_speech_input_streaming(voice_id, text_iterator):\n \"\"\"Send text to ElevenLabs API and stream the returned audio.\"\"\"\n uri = f\"wss://api.elevenlabs.io/v1/text-to-speech/{voice_id}/stream-input?model_id=eleven_flash_v2_5\"\n\n async with websockets.connect(uri) as websocket:\n await websocket.send(json.dumps({\n \"text\": \" \",\n \"voice_settings\": {\"stability\": 0.5, \"similarity_boost\": 0.8},\n \"xi_api_key\": ELEVENLABS_API_KEY,\n }))\n\n async def listen():\n \"\"\"Listen to the websocket for audio data and stream it.\"\"\"\n while True:\n try:\n message = await websocket.recv()\n data = json.loads(message)\n if data.get(\"audio\"):\n yield base64.b64decode(data[\"audio\"])\n elif data.get('isFinal'):\n break\n except websockets.exceptions.ConnectionClosed:\n print(\"Connection closed\")\n break\n\n listen_task = asyncio.create_task(stream(listen()))\n\n async for text in text_chunker(text_iterator):\n await websocket.send(json.dumps({\"text\": text}))\n\n await websocket.send(json.dumps({\"text\": \"\"}))\n\n await listen_task\n\n\nasync def chat_completion(query):\n \"\"\"Retrieve text from OpenAI and pass it to the text-to-speech function.\"\"\"\n response = await aclient.chat.completions.create(model='gpt-4', messages=[{'role': 'user', 'content': query}],\n temperature=1, stream=True)\n\n async def text_iterator():\n async for chunk in response:\n delta = chunk.choices[0].delta\n yield delta.content\n\n await text_to_speech_input_streaming(VOICE_ID, text_iterator())\n\n\n# Main execution\nif __name__ == \"__main__\":\n user_query = \"Hello, tell me a very long story.\"\n asyncio.run(chat_completion(user_query))\n\n\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,e.jsx)(t.h2,{id:\"example---other-examples-for-interacting-with-our-websocket-api\",children:\"Example - Other examples for interacting with our Websocket API\"}),`\n`,(0,e.jsx)(t.p,{children:\"Some examples for interacting with the Websocket API in different ways are provided below\"}),`\n`,(0,e.jsx)(s,{items:[{code:`import asyncio\nimport websockets\nimport json\nimport base64\n\nasync def text_to_speech(voice_id):\n model = 'eleven_flash_v2_5'\n uri = f\"wss://api.elevenlabs.io/v1/text-to-speech/{voice_id}/stream-input?model_id={model}\"\n\n async with websockets.connect(uri) as websocket:\n\n # Initialize the connection\n bos_message = {\n \"text\": \" \",\n \"voice_settings\": {\n \"stability\": 0.5,\n \"similarity_boost\": 0.8\n },\n \"xi_api_key\": \"api_key_here\", # Replace with your API key\n }\n await websocket.send(json.dumps(bos_message))\n\n # Send \"Hello World\" input\n input_message = {\n \"text\": \"Hello World \"\n }\n await websocket.send(json.dumps(input_message))\n\n # Send EOS message with an empty string instead of a single space\n # as mentioned in the documentation\n eos_message = {\n \"text\": \"\"\n }\n await websocket.send(json.dumps(eos_message))\n\n # Added a loop to handle server responses and print the data received\n while True:\n try:\n response = await websocket.recv()\n data = json.loads(response)\n print(\"Server response:\", data)\n\n if data[\"audio\"]:\n chunk = base64.b64decode(data[\"audio\"])\n print(\"Received audio chunk\")\n else:\n print(\"No audio data in the response\")\n break\n except websockets.exceptions.ConnectionClosed:\n print(\"Connection closed\")\n break\n\nasyncio.get_event_loop().run_until_complete(text_to_speech(\"voice_id_here\"))\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,title:\"Python websockets and asyncio\",wordWrap:!1,matchLanguage:void 0},{code:`const voiceId = 'voice_id_here'; // replace with your voice_id\nconst model = 'eleven_flash_v2_5';\nconst wsUrl = \\`wss://api.elevenlabs.io/v1/text-to-speech/\\${voiceId}/stream-input?model_id=\\${model}\\`;\nconst socket = new WebSocket(wsUrl);\n\n// 2. Initialize the connection by sending the BOS message\nsocket.onopen = function (event) {\n const bosMessage = {\n text: ' ',\n voice_settings: {\n stability: 0.5,\n similarity_boost: 0.8,\n },\n xi_api_key: 'api_key_here', // replace with your API key\n };\n\n socket.send(JSON.stringify(bosMessage));\n\n // 3. Send the input text message (\"Hello World\")\n const textMessage = {\n text: 'Hello World ',\n };\n\n socket.send(JSON.stringify(textMessage));\n\n // 4. Send the EOS message with an empty string\n const eosMessage = {\n text: '',\n };\n\n socket.send(JSON.stringify(eosMessage));\n};\n\n// 5. Handle server responses\nsocket.onmessage = function (event) {\n const response = JSON.parse(event.data);\n\n console.log('Server response:', response);\n\n if (response.audio) {\n // decode and handle the audio data (e.g., play it)\n const audioChunk = atob(response.audio); // decode base64\n console.log('Received audio chunk');\n } else {\n console.log('No audio data in the response');\n }\n\n if (response.isFinal) {\n // the generation is complete\n }\n\n if (response.normalizedAlignment) {\n // use the alignment info if needed\n }\n};\n\n// Handle errors\nsocket.onerror = function (error) {\n console.error(\\`WebSocket Error: \\${error}\\`);\n};\n\n// Handle socket closing\nsocket.onclose = function (event) {\n if (event.wasClean) {\n console.info(\\`Connection closed cleanly, code=\\${event.code}, reason=\\${event.reason}\\`);\n } else {\n console.warn('Connection died');\n }\n};\n`,language:\"javascript\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,title:\"Javascript websockets\",wordWrap:!1,matchLanguage:void 0},{code:`from elevenlabs import generate, stream\n\ndef text_stream():\n yield \"Hi there, I'm Eleven \"\n yield \"I'm a text to speech API \"\n\naudio_stream = generate(\n text=text_stream(),\n voice=\"Nicole\",\n model=\"eleven_flash_v2_5\",\n stream=True\n)\n\nstream(audio_stream)\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,title:\"elevenlabs-python\",wordWrap:!1,matchLanguage:void 0}]}),`\n`,(0,e.jsx)(t.h2,{id:\"example---getting-word-start-times-using-alignment-values\",children:\"Example - Getting word start times using alignment values\"}),`\n`,(0,e.jsx)(t.p,{children:\"This code example shows how the start times of words can be retrieved using the alignment values returned from our API.\"}),`\n`,(0,e.jsx)(o,{code:`import asyncio\nimport websockets\nimport json\nimport base64\n\n# Define API keys and voice ID\nELEVENLABS_API_KEY = \"INSERT HERE\" \u003c- INSERT YOUR API KEY HERE\nVOICE_ID = 'nPczCjzI2devNBz1zQrb' #Brian\n\ndef calculate_word_start_times(alignment_info):\n # Alignment start times are indexed from the start of the audio chunk that generated them\n # In order to analyse runtime over the entire response we keep a cumulative count of played audio\n full_alignment = {'chars': [], 'charStartTimesMs': [], 'charDurationsMs': []}\n cumulative_run_time = 0\n for old_dict in alignment_info:\n full_alignment['chars'].extend([\" \"] + old_dict['chars'])\n full_alignment['charDurationsMs'].extend([old_dict['charStartTimesMs'][0]] + old_dict['charDurationsMs'])\n full_alignment['charStartTimesMs'].extend([0] + [time+cumulative_run_time for time in old_dict['charStartTimesMs']])\n cumulative_run_time += sum(old_dict['charDurationsMs'])\n\n # We now have the start times of every character relative to the entire audio output\n zipped_start_times = list(zip(full_alignment['chars'], full_alignment['charStartTimesMs']))\n # Get the start time of every character that appears after a space and match this to the word\n words = ''.join(full_alignment['chars']).split(\" \")\n word_start_times = list(zip(words, [0] + [zipped_start_times[i+1][1] for (i, (a,b)) in enumerate(zipped_start_times) if a == ' ']))\n print(f\"total duration:{cumulative_run_time}\")\n print(word_start_times)\n\n\nasync def text_to_speech_alignment_example(voice_id, text_to_send):\n \"\"\"Send text to ElevenLabs API and stream the returned audio and alignment information.\"\"\"\n uri = f\"wss://api.elevenlabs.io/v1/text-to-speech/{voice_id}/stream-input?model_id=eleven_flash_v2_5\"\n async with websockets.connect(uri) as websocket:\n await websocket.send(json.dumps({\n \"text\": \" \",\n \"voice_settings\": {\"stability\": 0.5, \"similarity_boost\": 0.8, \"use_speaker_boost\": False},\n \"generation_config\": {\n \"chunk_length_schedule\": [120, 160, 250, 290]\n },\n \"xi_api_key\": ELEVENLABS_API_KEY,\n }))\n\n async def text_iterator(text):\n \"\"\"Split text into chunks to mimic streaming from an LLM or similar\"\"\"\n split_text = text.split(\" \")\n words = 0\n to_send = \"\"\n for chunk in split_text:\n to_send += chunk + ' '\n words += 1\n if words \u003e= 10:\n print(to_send)\n yield to_send\n words = 0\n to_send = \"\"\n yield to_send\n\n async def listen():\n \"\"\"Listen to the websocket for audio data and write it to a file.\"\"\"\n audio_chunks = []\n alignment_info = []\n received_final_chunk = False\n print(\"Listening for chunks from ElevenLabs...\")\n while not received_final_chunk:\n try:\n message = await websocket.recv()\n data = json.loads(message)\n if data.get(\"audio\"):\n audio_chunks.append(base64.b64decode(data[\"audio\"]))\n if data.get(\"alignment\"):\n alignment_info.append(data.get(\"alignment\"))\n if data.get('isFinal'):\n received_final_chunk = True\n break\n except websockets.exceptions.ConnectionClosed:\n print(\"Connection closed\")\n break\n print(\"Writing audio to file\")\n with open(\"output_file.mp3\", \"wb\") as f:\n f.write(b''.join(audio_chunks))\n\n calculate_word_start_times(alignment_info)\n\n\n listen_task = asyncio.create_task(listen())\n\n async for text in text_iterator(text_to_send):\n await websocket.send(json.dumps({\"text\": text}))\n await websocket.send(json.dumps({\"text\": \" \", \"flush\": True}))\n await listen_task\n\n\n# Main execution\nif __name__ == \"__main__\":\n text_to_send = \"The twilight sun cast its warm golden hues upon the vast rolling fields, saturating the landscape with an ethereal glow.\"\n asyncio.run(text_to_speech_alignment_example(VOICE_ID, text_to_send))\n`,language:\"python\",highlightLines:[],highlightStyle:\"highlight\",maxLines:20,wordWrap:!1,matchLanguage:!0}),`\n`,(0,e.jsx)(t.h2,{id:\"understanding-how-our-websockets-buffer-text\",children:\"Understanding how our websockets buffer text\"}),`\n`,(0,e.jsx)(t.p,{children:\"Our websocket service incorporates a buffer system designed to optimize the Time To First Byte (TTFB) while maintaining high-quality streaming.\"}),`\n`,(0,e.jsx)(t.p,{children:\"All text sent to the websocket endpoint is added to this buffer and only when that buffer reaches a certain size is an audio generation attempted. This is because our model provides higher quality audio when the model has longer inputs, and can deduce more context about how the text should be delivered.\"}),`\n`,(0,e.jsxs)(t.p,{children:[\"The buffer ensures smooth audio data delivery and is automatically emptied with a final audio generation either when the stream is closed, or upon sending a \",(0,e.jsx)(t.code,{children:\"flush\"}),\" command. We have advanced settings for changing the chunk schedule, which can improve latency at the cost of quality by generating audio more frequently with smaller text inputs.\"]})]})}function f(i={}){let{wrapper:t}={...h(),...i.components};return t?(0,e.jsx)(t,{...i,children:(0,e.jsx)(g,{...i})}):g(i)}function r(i,t){throw new Error(\"Expected \"+(t?\"component\":\"object\")+\" `\"+i+\"` to be defined: you likely forgot to import, pass, or provide it.\")}return S(A);})();\n;return Component;","frontmatter":{"title":"Websocket","headline":"Text to speech WebSocket API","edit-this-page-url":"https://github.com/elevenlabs/elevenlabs-docs/blob/main/fern/api-reference/pages/websocket.mdx?plain=1"},"scope":{},"jsxRefs":["ParamField","Expandable","Note","CodeGroup"]},"breadcrumb":[{"title":"API REFERENCE","pointsTo":"docs/api-reference/introduction"}],"neighbors":{"prev":null,"next":null},"hasAside":false}},"breadcrumb":[]},"navigation":{"currentTabIndex":2,"tabs":[{"type":"tabGroup","title":"Docs","index":0,"slug":"docs","pointsTo":"docs/overview"},{"type":"tabGroup","title":"Conversational AI","index":1,"slug":"docs/conversational-ai","pointsTo":"docs/conversational-ai/overview"},{"type":"tabGroup","title":"API reference","index":2,"slug":"docs","pointsTo":"docs/api-reference/introduction"}],"versions":[],"sidebar":{"type":"sidebarRoot","id":"2512984ea602967579eb7ec2419818a8a6f4f196dc7040a958b54f6e8c035dc4","children":[{"type":"apiReference","paginated":false,"showErrors":true,"hideTitle":false,"children":[{"type":"page","id":"d5a960f49f5c30fd6af497cdd7eaac6f0d42fe8a683b7043d2a0a3602e6a31f1","title":"Introduction","slug":"docs/api-reference/introduction","pageId":"api-reference/pages/introduction.mdx"},{"type":"page","id":"486577d350315b3adf2f6ad97c205109d25d1c40b6e863f0e5216e60dcb8b65d","title":"Authentication","slug":"docs/api-reference/authentication","pageId":"api-reference/pages/authentication.mdx"},{"type":"page","id":"9ff2036ccf416a76819fd24651fe0991d4a8f010e2ca5e3fad7a6503c89efa2c","title":"Streaming","slug":"docs/api-reference/streaming","pageId":"api-reference/pages/streaming.mdx"},{"type":"page","id":"a4cd6a5e8af0f9acd3588d9d67010e611316836a1cb4426b0525658ff0993081","title":"Websocket","slug":"docs/api-reference/websocket","pageId":"api-reference/pages/websocket.mdx"}],"title":"API REFERENCE","slug":"docs/api-reference","id":"92e5ea5a268b267968ab9485c9b7dd9bf2ee1161494ba1dfd955987aecfd6d3d","apiDefinitionId":"b3a79396-26a1-4552-813c-956902d5a173","pointsTo":"docs/api-reference/introduction"},{"type":"apiReference","paginated":true,"showErrors":true,"hideTitle":true,"children":[{"type":"apiPackage","id":"144125ddcb86373b6a343bef77725f3a988036f672421425859b6ad1959d7326","children":[{"type":"apiPackage","id":"81fb929c3b1e1026641b5332f37ec1e21607d10a79827a17f50d4aedd3a8d810","children":[{"type":"webSocket","id":"b99d7a8c31556e02d3732a8dd5651e57e66697cf5870b75ffba6aab983f59a98","title":"WebSockets","slug":"docs/api-reference/text-to-speech/text-to-speech","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","webSocketId":"subpackage_textToSpeech.textToSpeech"},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToSpeech.convert","title":"Create speech","slug":"docs/api-reference/text-to-speech/convert","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToSpeech.convert","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToSpeech.convert_with_timestamps","title":"Create speech with timing","slug":"docs/api-reference/text-to-speech/convert-with-timestamps","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToSpeech.convert_with_timestamps","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToSpeech.convert_as_stream","title":"Stream speech","slug":"docs/api-reference/text-to-speech/convert-as-stream","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToSpeech.convert_as_stream","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToSpeech.stream_with_timestamps","title":"Stream speech with timing","slug":"docs/api-reference/text-to-speech/stream-with-timestamps","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToSpeech.stream_with_timestamps","isResponseStream":true}],"title":"Text to Speech","slug":"docs/api-reference/text-to-speech","pointsTo":"docs/api-reference/text-to-speech/text-to-speech","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"2a7b77c84820216c27af805c9719de43dff3b926faadc47a93108ed5d9adb4ee","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_speechToSpeech.convert","title":"Voice changer","slug":"docs/api-reference/speech-to-speech/convert","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_speechToSpeech.convert","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_speechToSpeech.convert_as_stream","title":"Voice changer stream","slug":"docs/api-reference/speech-to-speech/convert-as-stream","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_speechToSpeech.convert_as_stream","isResponseStream":false}],"title":"Voice changer","slug":"docs/api-reference/speech-to-speech","pointsTo":"docs/api-reference/speech-to-speech/convert","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"ca9d0f1b19451b88c7084b4bcd007220d4e2e22c4c3be5a671ffacfb233a08a5","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToSoundEffects.convert","title":"Create sound effect","slug":"docs/api-reference/text-to-sound-effects/convert","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToSoundEffects.convert","isResponseStream":false}],"title":"Sound effects","slug":"docs/api-reference/text-to-sound-effects","pointsTo":"docs/api-reference/text-to-sound-effects/convert","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"b1aa9856280319c48668b82614d3b03df8c2882b5ee0beabd1647027b9d477eb","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_audioIsolation.audio_isolation","title":"Audio Isolation","slug":"docs/api-reference/audio-isolation/audio-isolation","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_audioIsolation.audio_isolation","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_audioIsolation.audio_isolation_stream","title":"Audio Isolation Stream","slug":"docs/api-reference/audio-isolation/audio-isolation-stream","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_audioIsolation.audio_isolation_stream","isResponseStream":false}],"title":"Audio Isolation","slug":"docs/api-reference/audio-isolation","pointsTo":"docs/api-reference/audio-isolation/audio-isolation","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"604327a132cf100e2e626b93c288a3bf37d5f7546ba30308d0bad712057b898e","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToVoice.create_previews","title":"Voice design","slug":"docs/api-reference/text-to-voice/create-previews","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToVoice.create_previews","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_textToVoice.create_voice_from_preview","title":"Save a voice preview","slug":"docs/api-reference/text-to-voice/create-voice-from-preview","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_textToVoice.create_voice_from_preview","isResponseStream":false}],"title":"Text to Voice","slug":"docs/api-reference/text-to-voice","pointsTo":"docs/api-reference/text-to-voice/create-previews","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"6ee7369fda7fa159b2cfc84051c49d81b70631b6e6a018998e4d033a43c93c32","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_dubbing.dub_a_video_or_an_audio_file","title":"Dub a video or audio file","slug":"docs/api-reference/dubbing/dub-a-video-or-an-audio-file","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_dubbing.dub_a_video_or_an_audio_file","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_dubbing.get_dubbing_project_metadata","title":"Get dubbing","slug":"docs/api-reference/dubbing/get-dubbing-project-metadata","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_dubbing.get_dubbing_project_metadata","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_dubbing.delete_dubbing_project","title":"Delete dubbing","slug":"docs/api-reference/dubbing/delete-dubbing-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_dubbing.delete_dubbing_project","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_dubbing.get_dubbed_file","title":"Get dubbed audio","slug":"docs/api-reference/dubbing/get-dubbed-file","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_dubbing.get_dubbed_file","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_dubbing.get_transcript_for_dub","title":"Get dubbed transcript","slug":"docs/api-reference/dubbing/get-transcript-for-dub","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_dubbing.get_transcript_for_dub","isResponseStream":false}],"title":"Dubbing","slug":"docs/api-reference/dubbing","pointsTo":"docs/api-reference/dubbing/dub-a-video-or-an-audio-file","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"}],"title":"ENDPOINTS","slug":"docs/api-reference","pointsTo":"docs/api-reference/text-to-speech/text-to-speech","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"3a192995b101791be4b6daa9399c4902d9fa08b76e03883ba7dc6aff39a728e4","children":[{"type":"apiPackage","id":"b8996c84ef55d57a04b66e60492ccbd396fec2d14d7142c4174e966e043cb019","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_audioNative.create","title":"Create audio native project","slug":"docs/api-reference/audio-native/create","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_audioNative.create","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_audioNative.update_content","title":"Update audio native project","slug":"docs/api-reference/audio-native/update-content","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_audioNative.update_content","isResponseStream":false}],"title":"Audio Native","slug":"docs/api-reference/audio-native","pointsTo":"docs/api-reference/audio-native/create","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"578e3bad7eeb4467e7e132ed3f0638205592308d6fec35a5eaee6e86a80c1524","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_history.get_all","title":"Get generated items","slug":"docs/api-reference/history/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_history.get_all","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_history.get","title":"Get history item","slug":"docs/api-reference/history/get","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_history.get","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_history.delete","title":"Delete history item","slug":"docs/api-reference/history/delete","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_history.delete","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_history.get_audio","title":"Get audio from history item","slug":"docs/api-reference/history/get-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_history.get_audio","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_history.download","title":"Download history items","slug":"docs/api-reference/history/download","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_history.download","isResponseStream":false}],"title":"History","slug":"docs/api-reference/history","pointsTo":"docs/api-reference/history/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"991ae64139611c701986b829680ba70a2ca4b4bf1f0106e84b1719ed0a375828","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_models.get_all","title":"List models","slug":"docs/api-reference/models/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_models.get_all","isResponseStream":false}],"title":"Models","slug":"docs/api-reference/models","pointsTo":"docs/api-reference/models/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"e9dd1dff99fc097cdbeea81af214c8e30b9c62be1bc7825d1d67fd0a52488b81","children":[{"type":"page","id":"b0eeedd11d96b774e53bf796adf6c3dd74b7a9fd31492e874954e3f5cda33455","title":"Studio API information","slug":"docs/api-reference/studio-api-information","icon":"duotone exclamation-triangle","pageId":"api-reference/pages/studio-info.mdx"},{"type":"endpoint","id":"f24456a1a57ac27266edc37100ffb6aca74ab435347086d800647c196f74e6c0","title":"List Studio Projects","slug":"docs/api-reference/studio/get-projects","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/projects.get_all","isResponseStream":false},{"type":"endpoint","id":"5d2e08211b6862da3447a7b8a4dacd8cc141d65b81efad397e6db12d9827f4a0","title":"Update Studio Project Metadata","slug":"docs/api-reference/studio/edit-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.update_metadata","isResponseStream":false},{"type":"endpoint","id":"80ea7b95623a13c62343cb43497b7df678088406740fbcad86ddd72497448e3a","title":"Get Studio Project","slug":"docs/api-reference/studio/get-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/projects.get","isResponseStream":false},{"type":"endpoint","id":"995799121cd1ab43cff652640a31adf964a23afedb5b6ae8c542163fb1a69ee6","title":"Create Studio Project","slug":"docs/api-reference/studio/add-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.add","isResponseStream":false},{"type":"endpoint","id":"b881639845a5b7e067d0b5145ed7610a10a97529ef89eb61842b9809490e790a","title":"Delete Studio Project","slug":"docs/api-reference/studio/delete-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_studio/projects.delete","isResponseStream":false},{"type":"endpoint","id":"040045bdeccb0ad6597b24630fc3c419d79d69f62e0eb747607590aa66f292c6","title":"Convert Studio Project","slug":"docs/api-reference/studio/convert-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.convert","isResponseStream":false},{"type":"endpoint","id":"7d8a293c898ec36a46cb419720a2e8420ec74ecd3dae53b879ca2100c36c10ec","title":"Update Studio Project Content","slug":"docs/api-reference/studio/update-content","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.update_content","isResponseStream":false},{"type":"endpoint","id":"f15d46601406dea4f5132255dc1edd867ddcd9938465b2bc5f24b3a9538784c5","title":"List Studio Project Snapshots","slug":"docs/api-reference/studio/get-snapshots","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/projects.get_snapshots","isResponseStream":false},{"type":"endpoint","id":"41529a92cb48cb97625dfcb58241d4808a15f87fe75403de91fad1ab962ed8cd","title":"Stream Studio Project Audio","slug":"docs/api-reference/studio/stream-snapshot","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.stream_audio","isResponseStream":false},{"type":"endpoint","id":"be5c4aa4dcf828de2af30312ad4b52f64c7c04b7c161c612c31dd52574dbdc48","title":"Streams Archive With Studio Project Audio","slug":"docs/api-reference/studio/archive-snapshot","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.stream_archive","isResponseStream":false},{"type":"endpoint","id":"a87628e23cd1650a08cd3945c142590b45210f833b1f26078fbf72584137e3f7","title":"List Chapters","slug":"docs/api-reference/studio/get-chapters","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/chapters.get_all","isResponseStream":false},{"type":"endpoint","id":"288cdd6eceb06e7fe15e9e99af8d601ac3a72889dcc41528e6883aa294cc4ccb","title":"Get Chapter","slug":"docs/api-reference/studio/get-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/chapters.get","isResponseStream":false},{"type":"endpoint","id":"571808c403b71abbf38f3f26131e6e243c272a8338995f56e0607ab2a710f578","title":"Create Chapter","slug":"docs/api-reference/studio/add-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/chapters.create","isResponseStream":false},{"type":"endpoint","id":"32cb6e6dfb0cb3564780250101930c596167139eda77a53bb2828a33928a69d5","title":"Update Chapter","slug":"docs/api-reference/studio/update-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/chapters.edit","isResponseStream":false},{"type":"endpoint","id":"3d4338d786de4817e259c866e3f8ed43e24850542e21b1d1867d8d10311c26df","title":"Delete Chapter","slug":"docs/api-reference/studio/delete-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_studio/chapters.delete","isResponseStream":false},{"type":"endpoint","id":"b253cf37df6a7bdbe3fa33f17222162b4ddf6d29eeb558604060527d9d699331","title":"Convert Chapter","slug":"docs/api-reference/studio/convert-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/chapters.convert","isResponseStream":false},{"type":"endpoint","id":"63b1c6957b30e224df26cf2573155bc43d8c0d040dfbdef90c3c7c85097d425f","title":"List Chapter Snapshots","slug":"docs/api-reference/studio/get-snapshots","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_studio/chapters.get_all_snapshots","isResponseStream":false},{"type":"endpoint","id":"5ced6337944c469d3d2dfdc89374d235e2104ee79fdfc251b978f39c4e541823","title":"Stream Chapter Audio","slug":"docs/api-reference/studio/stream-snapshot","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/chapters.stream_snapshot","isResponseStream":false},{"type":"endpoint","id":"97e98d33aea52bbdcc800a6b8b702af3bad537f19ca338b069a7efd27ea441d1","title":"Create Pronunciation Dictionaries","slug":"docs/api-reference/studio/create-pronunciation-dictionaries","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio/projects.update_pronunciation_dictionaries","isResponseStream":false},{"type":"endpoint","id":"d3814f0fb5d77b14236b8e94cadf32eba830c9b4c6468a1ba28c915e38f681e9","title":"Create Podcast","slug":"docs/api-reference/studio/create-podcast","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_studio.create_podcast","isResponseStream":false}],"title":"Studio","slug":"docs/api-reference","pointsTo":"docs/api-reference/studio-api-information","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"567269f2c2aac763719eeabfe9d437d7cbc3d75bc57eacb4fa29bdf25cea0457","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.add_from_file","title":"Create a pronunciation dictionary","slug":"docs/api-reference/pronunciation-dictionary/add-from-file","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_pronunciationDictionary.add_from_file","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.add_rules","title":"Add pronunciation dictionary rules","slug":"docs/api-reference/pronunciation-dictionary/add-rules","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_pronunciationDictionary.add_rules","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.remove_rules","title":"Remove pronunciation dictionary rules","slug":"docs/api-reference/pronunciation-dictionary/remove-rules","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_pronunciationDictionary.remove_rules","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.download","title":"Get pronunciation dictionary by version","slug":"docs/api-reference/pronunciation-dictionary/download","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_pronunciationDictionary.download","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.get","title":"Get pronunciation dictionary","slug":"docs/api-reference/pronunciation-dictionary/get","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_pronunciationDictionary.get","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_pronunciationDictionary.get_all","title":"List pronunciation dictionaries","slug":"docs/api-reference/pronunciation-dictionary/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_pronunciationDictionary.get_all","isResponseStream":false}],"title":"Pronunciation Dictionary","slug":"docs/api-reference/pronunciation-dictionary","pointsTo":"docs/api-reference/pronunciation-dictionary/add-from-file","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"9993f22ec133ade1902530826e6a00113a335e9dc77eb567fd7963671a51e4c6","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_samples.delete","title":"Delete voice sample","slug":"docs/api-reference/samples/delete","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_samples.delete","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_samples.get_audio","title":"Get audio from sample","slug":"docs/api-reference/samples/get-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_samples.get_audio","isResponseStream":false}],"title":"Samples","slug":"docs/api-reference/samples","pointsTo":"docs/api-reference/samples/delete","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"86206f528eb55077046b513d425cf21f388882c52e8e5f1b2b994b57af249e69","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_usage.get_characters_usage_metrics","title":"Get character usage metrics","slug":"docs/api-reference/usage/get-characters-usage-metrics","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_usage.get_characters_usage_metrics","isResponseStream":false}],"title":"Usage","slug":"docs/api-reference/usage","pointsTo":"docs/api-reference/usage/get-characters-usage-metrics","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"1a856b54ec56cc967a80dfb16e85025728d87614c8d9fc24eac65c2af9dafeda","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_user.get_subscription","title":"Get user subscription","slug":"docs/api-reference/user/get-subscription","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_user.get_subscription","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_user.get","title":"Get user","slug":"docs/api-reference/user/get","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_user.get","isResponseStream":false}],"title":"User","slug":"docs/api-reference/user","pointsTo":"docs/api-reference/user/get-subscription","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"203493574caa6fc33876fa803b49b623037cb0ea9ff54b8700932274319400d2","children":[{"type":"endpoint","id":"860bcb426fa9f124f0d774266d4af58c93b807193e6047a89d7b1dc1a4fded8d","title":"Get shared voices","slug":"docs/api-reference/voice-library/get-shared","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_voices.get_shared","isResponseStream":false},{"type":"endpoint","id":"ca149bde9c5bfb97c5549734395dc0e776cfd7f012e4a8d7e4c13c24020b16b5","title":"Add shared voice","slug":"docs/api-reference/voice-library/add-sharing-voice","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_voices.add_sharing_voice","isResponseStream":false}],"title":"Voice Library","slug":"docs/api-reference/voice-library","pointsTo":"docs/api-reference/voice-library/get-shared","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"6b5fc9c6a1119a1bbc032e7e828f753d1a442e9b330201ad1d4a059df8a6c0b2","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.get_all","title":"List voices","slug":"docs/api-reference/voices/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_voices.get_all","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.get_default_settings","title":"Get default voice settings","slug":"docs/api-reference/voices/get-default-settings","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_voices.get_default_settings","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.get_settings","title":"Get voice settings","slug":"docs/api-reference/voices/get-settings","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_voices.get_settings","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.get","title":"Get voice","slug":"docs/api-reference/voices/get","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_voices.get","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.delete","title":"Delete voice","slug":"docs/api-reference/voices/delete","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_voices.delete","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.edit_settings","title":"Edit voice settings","slug":"docs/api-reference/voices/edit-settings","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_voices.edit_settings","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.add","title":"Create voice clone","slug":"docs/api-reference/voices/add","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_voices.add","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.edit","title":"Edit voice","slug":"docs/api-reference/voices/edit","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_voices.edit","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_voices.get_similar_library_voices","title":"List similar voices","slug":"docs/api-reference/voices/get-similar-library-voices","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_voices.get_similar_library_voices","isResponseStream":false}],"title":"Voices","slug":"docs/api-reference/voices","pointsTo":"docs/api-reference/voices/get-all","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"3f1450e9212f1bdc26aaa574f890fc7529c0db52ff55d267b565b20ecb7c9e36","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.searchUserGroups","title":"Search user group","slug":"docs/api-reference/workspace/search-user-groups","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_workspace.searchUserGroups","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.deleteMemberFromUserGroup","title":"Remove member from user group","slug":"docs/api-reference/workspace/delete-member-from-user-group","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_workspace.deleteMemberFromUserGroup","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.addMemberToUserGroup","title":"Add member to user group","slug":"docs/api-reference/workspace/add-member-to-user-group","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_workspace.addMemberToUserGroup","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.inviteUser","title":"Invite user","slug":"docs/api-reference/workspace/invite-user","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_workspace.inviteUser","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.inviteMultipleUsers","title":"Invite Multiple Users","slug":"docs/api-reference/workspace/invite-multiple-users","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_workspace.inviteMultipleUsers","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.deleteExistingInvitation","title":"Delete invite","slug":"docs/api-reference/workspace/delete-existing-invitation","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_workspace.deleteExistingInvitation","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_workspace.updateMember","title":"Update member","slug":"docs/api-reference/workspace/update-member","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_workspace.updateMember","isResponseStream":false}],"title":"Workspace","slug":"docs/api-reference/workspace","pointsTo":"docs/api-reference/workspace/search-user-groups","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"}],"title":"ADMINISTRATION","slug":"docs/api-reference","pointsTo":"docs/api-reference/audio-native/create","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"1e50a61324e2fc0a5fbfb3acab2084a4ef257d046d529fb3d4c5530775e2a213","children":[{"type":"apiPackage","id":"cfd614c4a214ff10fb0deaca3046c20e658bb16e0527078634caeeaae3bb850b","children":[{"type":"endpoint","id":"be8f82e6f0f0b8e980eb45d963dc1529c646682ad0a8975ab3f97821977ff7f0","title":"Create agent","slug":"docs/api-reference/agents/create-agent","canonicalSlug":"docs/conversational-ai/api-reference/agents/create-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.create_agent","isResponseStream":false},{"type":"endpoint","id":"a68a30fd7d2329c1e84e17827e00f0e612a006ba9a78efa46bba6d484eb008bd","title":"Get agent","slug":"docs/api-reference/agents/get-agent","canonicalSlug":"docs/conversational-ai/api-reference/agents/get-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_agent","isResponseStream":false},{"type":"endpoint","id":"45a48429dc3a14922d0d9e53267469b430930a74b50e760198d8e1ad11197804","title":"List agents","slug":"docs/api-reference/agents/get-agents","canonicalSlug":"docs/conversational-ai/api-reference/agents/get-agents","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_agents","isResponseStream":false},{"type":"endpoint","id":"6a05bc1e14500e182f22778142f8b40d930de22a13e35f79e9253d41e75fe31e","title":"Update agent","slug":"docs/api-reference/agents/update-agent","canonicalSlug":"docs/conversational-ai/api-reference/agents/update-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"PATCH","endpointId":"endpoint_conversationalAi.update_agent","isResponseStream":false},{"type":"endpoint","id":"c22338b4d5737d44305caa76bf4df6140c031c7f559693bed737501998ad774c","title":"Delete agent","slug":"docs/api-reference/agents/delete-agent","canonicalSlug":"docs/conversational-ai/api-reference/agents/delete-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_conversationalAi.delete_agent","isResponseStream":false},{"type":"endpoint","id":"0f66ead3292b8ea8dfb5ed6fa744b8cae3ef047eefaa357e58711a68744f65a1","title":"Get link","slug":"docs/api-reference/agents/get-agent-link","canonicalSlug":"docs/conversational-ai/api-reference/agents/get-agent-link","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_agent_link","isResponseStream":false}],"title":"Agents","slug":"docs/api-reference/agents","pointsTo":"docs/api-reference/agents/create-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"504c86f99caaa4185ce338f439e927402e47fda8bbfc671ac2000d793f93767b","children":[{"type":"endpoint","id":"f801bb1dd75c8b7a89092fcc8ce4e02cc84372f8669da09050c7c7f02c6c2740","title":"List conversations","slug":"docs/api-reference/conversations/get-conversations","canonicalSlug":"docs/conversational-ai/api-reference/conversations/get-conversations","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_conversations","isResponseStream":false},{"type":"endpoint","id":"eb8b2bb188200c838d940f49e012451dbdc78921deb6712ef2d291a8ce81ce72","title":"Get conversation","slug":"docs/api-reference/conversations/get-conversation","canonicalSlug":"docs/conversational-ai/api-reference/conversations/get-conversation","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_conversation","isResponseStream":false},{"type":"endpoint","id":"cee59019ff528e734edcb3302aaad9d6e198dc035781a0521d763cf09b1fd726","title":"Delete conversation","slug":"docs/api-reference/conversations/delete-conversation","canonicalSlug":"docs/conversational-ai/api-reference/conversations/delete-conversation","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_conversationalAi.delete_conversation","isResponseStream":false},{"type":"endpoint","id":"251d58de3416e907673bfff66be183f27ddfda0b368dee750103338eaa488c04","title":"Get conversation audio","slug":"docs/api-reference/conversations/get-conversation-audio","canonicalSlug":"docs/conversational-ai/api-reference/conversations/get-conversation-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_conversation_audio","isResponseStream":false},{"type":"endpoint","id":"261d4e1c73b67b5d875b648e98e5b59479d73823d3c38533d3f3dc6f9aca453d","title":"Get signed URL","slug":"docs/api-reference/conversations/get-signed-url","canonicalSlug":"docs/conversational-ai/api-reference/conversations/get-signed-url","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_signed_url","isResponseStream":false},{"type":"endpoint","id":"e9d782ed7306e33261b772b35fe49bbb8be9f09f0de40718935990e746b85c6b","title":"Send conversation feedback","slug":"docs/api-reference/conversations/post-conversation-feedback","canonicalSlug":"docs/conversational-ai/api-reference/conversations/post-conversation-feedback","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.post_conversation_feedback","isResponseStream":false}],"title":"Conversations","slug":"docs/api-reference/conversations","pointsTo":"docs/api-reference/conversations/get-conversations","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"0200747f68db4ab297e782306b40fc69fb4988686888e80f1a247be11533161b","children":[{"type":"endpoint","id":"c20d804cb5a6b0d52edaebf9368d0b7b97cec9734162f386c0a02c24c8274dfd","title":"List knowledge base documents","slug":"docs/api-reference/knowledge-base/get-knowledge-base-list","canonicalSlug":"docs/conversational-ai/api-reference/knowledge-base/get-knowledge-base-list","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_knowledge_base_list","isResponseStream":false},{"type":"endpoint","id":"11ca5469e034cadf9d5f5365d4e29dd8b4498a26b4299585e2da3b9df0232b16","title":"Delete knowledge base document","slug":"docs/api-reference/knowledge-base/delete-knowledge-base-document","canonicalSlug":"docs/conversational-ai/api-reference/knowledge-base/delete-knowledge-base-document","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_conversationalAi.delete_knowledge_base_document","isResponseStream":false},{"type":"endpoint","id":"c3aab27037fbf052f4cc2d6b6efe127f6b85b757b5c363bb9ef886dec6f41c7a","title":"Get knowledge base document","slug":"docs/api-reference/knowledge-base/get-knowledge-base-document-by-id","canonicalSlug":"docs/conversational-ai/api-reference/knowledge-base/get-knowledge-base-document-by-id","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_knowledge_base_document_by_id","isResponseStream":false},{"type":"endpoint","id":"5c5b28e04a2f091dacfabe47873373ba5aa02134e1b1604769db86256dc2ac19","title":"Create knowledge base document","slug":"docs/api-reference/knowledge-base/add-to-knowledge-base","canonicalSlug":"docs/conversational-ai/api-reference/knowledge-base/add-to-knowledge-base","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.add_to_knowledge_base","isResponseStream":false},{"type":"endpoint","id":"d2df2f60134cf85ce580b0377dd0cee1fbafd1fe4dd4f64929eb2a5a3ea87ee2","title":"Get dependent agents","slug":"docs/api-reference/knowledge-base/get-dependent-agents","canonicalSlug":"docs/conversational-ai/api-reference/knowledge-base/get-dependent-agents","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_dependent_agents","isResponseStream":false}],"title":"Knowledge Base","slug":"docs/api-reference/knowledge-base","pointsTo":"docs/api-reference/knowledge-base/get-knowledge-base-list","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"9834f36f8b4936c16d7c859e4a709d84a5dc415fb9fd4063a09be76e50395d37","children":[{"type":"endpoint","id":"5d415bf5428c4395b4f06d67e1059a8d54afbb95a4ac7a2737e69126823fa945","title":"List tools","slug":"docs/api-reference/tools/get-tools","canonicalSlug":"docs/conversational-ai/api-reference/tools/get-tools","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_tools","isResponseStream":false},{"type":"endpoint","id":"8c30ddc05a1e2db08c29127803bbdaa552dae552b16b19201af025b0776bf841","title":"Get tool","slug":"docs/api-reference/tools/get-tool","canonicalSlug":"docs/conversational-ai/api-reference/tools/get-tool","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_tool","isResponseStream":false},{"type":"endpoint","id":"b68a7abe02c8d284b63d7986c926e575b4d8d3932857efa17316a6d0c2fd922f","title":"Create tool","slug":"docs/api-reference/tools/add-tool","canonicalSlug":"docs/conversational-ai/api-reference/tools/add-tool","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.add_tool","isResponseStream":false},{"type":"endpoint","id":"f8c85a786ec1857f0fbb9673d16043f5f128d990cc1322c73fdfd3c857b62714","title":"Update tool","slug":"docs/api-reference/tools/update-tool","canonicalSlug":"docs/conversational-ai/api-reference/tools/update-tool","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"PATCH","endpointId":"endpoint_conversationalAi.update_tool","isResponseStream":false},{"type":"endpoint","id":"9aea3594384c7a6ddcf7c3a8d8b5a08d94c987c31c0d3ad74ebec18d48b9da78","title":"Delete tool","slug":"docs/api-reference/tools/remove-tool","canonicalSlug":"docs/conversational-ai/api-reference/tools/remove-tool","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_conversationalAi.remove_tool","isResponseStream":false}],"title":"Tools","slug":"docs/api-reference/tools","pointsTo":"docs/api-reference/tools/get-tools","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"329edaecd0d2341ff600a17eeb5853e28e0a1ec1bd33c201700c53816b59ccb8","children":[{"type":"endpoint","id":"bdcc50a088da8851e71fb8f079e9d0cac04d70e8d24add93fb96eeb73cde9ca0","title":"Create phone number","slug":"docs/api-reference/phone-numbers/create-phone-number","canonicalSlug":"docs/conversational-ai/api-reference/phone-numbers/create-phone-number","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.create_phone_number","isResponseStream":false},{"type":"endpoint","id":"f91b1933a269301da53dddb61799c8f6396805b12cebe90967ad09bf9c9ddba0","title":"List phone numbers","slug":"docs/api-reference/phone-numbers/get-phone-numbers","canonicalSlug":"docs/conversational-ai/api-reference/phone-numbers/get-phone-numbers","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_phone_numbers","isResponseStream":false},{"type":"endpoint","id":"4b2bc23866268b92cf30d3243994ed2e325e3fe8013f55bb5253620735f200d6","title":"Get phone number","slug":"docs/api-reference/phone-numbers/get-phone-number","canonicalSlug":"docs/conversational-ai/api-reference/phone-numbers/get-phone-number","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_phone_number","isResponseStream":false},{"type":"endpoint","id":"fcc560e91aecd116947dc06e4f135548f535882cc09d995e08ee3d0c1307a749","title":"Update phone number","slug":"docs/api-reference/phone-numbers/update-phone-number","canonicalSlug":"docs/conversational-ai/api-reference/phone-numbers/update-phone-number","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"PATCH","endpointId":"endpoint_conversationalAi.update_phone_number","isResponseStream":false},{"type":"endpoint","id":"07e2fd403340f0788b3c266b62612eb04772e803c2563d881daabae1033b44d9","title":"Delete phone number","slug":"docs/api-reference/phone-numbers/delete-phone-number","canonicalSlug":"docs/conversational-ai/api-reference/phone-numbers/delete-phone-number","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"DELETE","endpointId":"endpoint_conversationalAi.delete_phone_number","isResponseStream":false}],"title":"Phone Numbers","slug":"docs/api-reference/phone-numbers","pointsTo":"docs/api-reference/phone-numbers/create-phone-number","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"e2e286b124f32be30f10352e00cbf644b5b4fdd07be81bdecbdc526751bae6ee","children":[{"type":"endpoint","id":"ec4f346ab08cae134353250311dc9303a0537b18adb279e3e80f97d65bbb3e54","title":"Get widget","slug":"docs/api-reference/widget/get-agent-widget","canonicalSlug":"docs/conversational-ai/api-reference/widget/get-agent-widget","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"GET","endpointId":"endpoint_conversationalAi.get_agent_widget","isResponseStream":false},{"type":"endpoint","id":"3639fa34bba1533a516ea16c6856113091277a273391a4213980fb41915c1edd","title":"Create widget avatar","slug":"docs/api-reference/widget/post-agent-avatar","canonicalSlug":"docs/conversational-ai/api-reference/widget/post-agent-avatar","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","method":"POST","endpointId":"endpoint_conversationalAi.post_agent_avatar","isResponseStream":false}],"title":"Widget","slug":"docs/api-reference/widget","pointsTo":"docs/api-reference/widget/get-agent-widget","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"}],"title":"CONVERSATIONAL AI","slug":"docs/api-reference","pointsTo":"docs/api-reference/agents/create-agent","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"1a9f1ea3146be0f37775524bd0e2df97c4da4c40297109752c0bf74b5207d1e9","children":[{"type":"apiPackage","id":"d06a03ff88b259c5b24ba9940212649ec9035fd6a4d1f889cc900a99ccca36f0","children":[{"type":"endpoint","id":"be4e09a3ee55851e7a487469cd43d1ea5be99b29d006f8f2bd2a2c1250c7dbc5","title":"Generate A Random Voice","slug":"docs/api-reference/voice-generation-deprecated/generate","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_voiceGeneration.generate","isResponseStream":false},{"type":"endpoint","id":"9dc255adfdd4f60caf048e84cba5acac0422968167301566070646d73dbf66a4","title":"Voice Generation Parameters","slug":"docs/api-reference/voice-generation-deprecated/generate-parameters","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_voiceGeneration.generate_parameters","isResponseStream":false},{"type":"endpoint","id":"10168970d94a0881583b6307ee39dd116e4f26b6efa04fd60977f930ee54da95","title":"Create A Previously Generated Voice","slug":"docs/api-reference/voice-generation-deprecated/create-a-previously-generated-voice","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_voiceGeneration.create_a_previously_generated_voice","isResponseStream":false}],"title":"Voice Generation (Deprecated)","slug":"docs/api-reference/voice-generation-deprecated","pointsTo":"docs/api-reference/voice-generation-deprecated/generate","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"},{"type":"apiPackage","id":"432b1ac16d13af1aa1ae42b4c65862008c0b8058a634d7e422fa7735333e7c63","children":[{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.createPodcast","title":"Create Podcast","slug":"docs/api-reference/projects/create-podcast","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.createPodcast","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.getProjects","title":"Get Projects","slug":"docs/api-reference/projects/get-projects","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.getProjects","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.addProject","title":"Add Project","slug":"docs/api-reference/projects/add-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.addProject","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.getProjectById","title":"Get Project By Id","slug":"docs/api-reference/projects/get-project-by-id","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.getProjectById","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.editBasicProjectInfo","title":"Edit Basic Project Info","slug":"docs/api-reference/projects/edit-basic-project-info","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.editBasicProjectInfo","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.deleteProject","title":"Delete Project","slug":"docs/api-reference/projects/delete-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"DELETE","endpointId":"endpoint_projects.deleteProject","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.editProjectContent","title":"Edit Project Content","slug":"docs/api-reference/projects/edit-project-content","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.editProjectContent","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.convertProject","title":"Convert Project","slug":"docs/api-reference/projects/convert-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.convertProject","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.getProjectSnapshots","title":"Get Project Snapshots","slug":"docs/api-reference/projects/get-project-snapshots","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.getProjectSnapshots","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.streamProjectAudio","title":"Stream Project Audio","slug":"docs/api-reference/projects/stream-project-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.streamProjectAudio","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.streamsArchiveWithProjectAudio","title":"Streams Archive With Project Audio","slug":"docs/api-reference/projects/streams-archive-with-project-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.streamsArchiveWithProjectAudio","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.getChapters","title":"Get Chapters","slug":"docs/api-reference/projects/get-chapters","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.getChapters","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.getChapterById","title":"Get Chapter By Id","slug":"docs/api-reference/projects/get-chapter-by-id","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.getChapterById","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.deleteChapter","title":"Delete Chapter","slug":"docs/api-reference/projects/delete-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"DELETE","endpointId":"endpoint_projects.deleteChapter","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.editChapter","title":"Edit Chapter","slug":"docs/api-reference/projects/edit-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"PATCH","endpointId":"endpoint_projects.editChapter","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.addChapterToAProject","title":"Add Chapter To A Project","slug":"docs/api-reference/projects/add-chapter-to-a-project","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.addChapterToAProject","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.convertChapter","title":"Convert Chapter","slug":"docs/api-reference/projects/convert-chapter","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.convertChapter","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.listChapterSnapshots","title":"List Chapter Snapshots","slug":"docs/api-reference/projects/list-chapter-snapshots","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"GET","endpointId":"endpoint_projects.listChapterSnapshots","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.streamChapterAudio","title":"Stream Chapter Audio","slug":"docs/api-reference/projects/stream-chapter-audio","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.streamChapterAudio","isResponseStream":false},{"type":"endpoint","id":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d:endpoint_projects.updatePronunciationDictionaries","title":"Update Pronunciation Dictionaries","slug":"docs/api-reference/projects/update-pronunciation-dictionaries","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","availability":"Deprecated","method":"POST","endpointId":"endpoint_projects.updatePronunciationDictionaries","isResponseStream":false}],"title":"projects","slug":"docs/api-reference/projects","pointsTo":"docs/api-reference/projects/create-podcast","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"}],"title":"LEGACY","slug":"docs/api-reference","pointsTo":"docs/api-reference/voice-generation-deprecated/generate","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d"}],"title":"API REFERENCE","slug":"docs/api-reference","id":"3c1be590259c0674ef6a0e6e97d6b7ba46942152cbd7a26106992937a6993994","apiDefinitionId":"85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","pointsTo":"docs/api-reference/text-to-speech/text-to-speech"}]},"trailingSlash":false},"edgeFlags":{"isApiPlaygroundEnabled":true,"isApiScrollingDisabled":false,"isWhitelabeled":false,"isSeoDisabled":false,"isTocDefaultEnabled":false,"isSnippetTemplatesEnabled":true,"isSearchDisabled":false,"isHttpSnippetsEnabled":true,"isInlineFeedbackEnabled":false,"isDarkCodeEnabled":false,"isProxyDisabled":false,"isImageZoomDisabled":false,"useJavaScriptAsTypeScript":false,"alwaysEnableJavaScriptFetch":false,"scrollInContainerEnabled":false,"useMdxBundler":true,"isBatchStreamToggleDisabled":false,"isAuthEnabledInDocs":false,"isAskAiEnabled":true,"isAudioFileDownloadSpanSummary":true,"isDocsLogoTextEnabled":false,"isAudioExampleInternal":true,"usesApplicationJsonInFormDataValue":false,"isBinaryOctetStreamAudioPlayer":false,"hasVoiceIdPlaygroundForm":true,"isCohereTheme":false,"isFileForgeHackEnabled":false,"is404PageHidden":true,"isNewSearchExperienceEnabled":false,"isAuthenticatedPagesDiscoverable":false,"isSearchV2Enabled":true},"apis":["2eeb422d-6784-4f89-a014-28225ac81e68","85a2aa1a-06ac-41cb-b24c-ed433c81aa8d","ae5e2e00-2fa5-40c9-a058-21050a3352d0","b3a79396-26a1-4552-813c-956902d5a173"],"seo":{"openGraph":{"siteName":"ElevenLabs Documentation"},"twitter":{},"additionalMetaTags":[],"additionalLinkTags":[{"rel":"icon","href":"https://files.buildwithfern.com/https://elevenlabs.docs.buildwithfern.com/docs/2025-02-18T16:19:50.716Z/assets/favicon.svg","crossOrigin":"anonymous"}],"breadcrumbList":{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"ElevenLabs Documentation","item":"https://elevenlabs.io/docs"},{"@type":"ListItem","position":2,"name":"API REFERENCE","item":"https://elevenlabs.io/docs/api-reference"},{"@type":"ListItem","position":3,"name":"Introduction","item":"https://elevenlabs.io/docs/api-reference/introduction"}]},"canonical":"https://elevenlabs.io/docs/api-reference/introduction","title":"Introduction","description":"Welcome to the ElevenLabs API reference.","titleTemplate":"%s — ElevenLabs Documentation","noindex":false,"nofollow":false},"fallback":{},"analytics":{"ga4":{"measurementId":"G-82RG1PXYVW"}},"theme":"default","analyticsConfig":{"posthog":{"apiKey":"phc_KQDh5IkRcTsPOoUtwmVxoATdOqNYCo0vTdwE77aNOQv","endpoint":"https://eu.i.posthog.com"},"ga4":{"measurementId":"G-82RG1PXYVW"}},"defaultLang":"curl","stylesheet":"\n:root {\n --typography-body-font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-heading-font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-code-font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;\n --spacing-page-width: 100%;\n --spacing-content-width: 44rem;\n --spacing-content-wide-width: 66.5rem;\n --spacing-sidebar-width: 240px;\n --spacing-header-height: 5.875rem;\n --spacing-header-height-padded: 66px;\n --spacing-header-height-real: 3.125rem;\n \n --grayscale-1: var(--gray-1);\n --grayscale-2: var(--gray-2);\n --grayscale-3: var(--gray-3);\n --grayscale-4: var(--gray-4);\n --grayscale-5: var(--gray-5);\n --grayscale-6: var(--gray-6);\n --grayscale-7: var(--gray-7);\n --grayscale-8: var(--gray-8);\n --grayscale-9: var(--gray-9);\n --grayscale-10: var(--gray-10);\n --grayscale-11: var(--gray-11);\n --grayscale-12: var(--gray-12);\n --grayscale-a1: var(--gray-a1);\n --grayscale-a2: var(--gray-a2);\n --grayscale-a3: var(--gray-a3);\n --grayscale-a4: var(--gray-a4);\n --grayscale-a5: var(--gray-a5);\n --grayscale-a6: var(--gray-a6);\n --grayscale-a7: var(--gray-a7);\n --grayscale-a8: var(--gray-a8);\n --grayscale-a9: var(--gray-a9);\n --grayscale-a10: var(--gray-a10);\n --grayscale-a11: var(--gray-a11);\n --grayscale-a12: var(--gray-a12);\n --accent-1: #fdfdfd;\n --accent-2: #fafafa;\n --accent-3: #f2f2f2;\n --accent-4: #e9e9e9;\n --accent-5: #e0e0e0;\n --accent-6: #d3d3d3;\n --accent-7: #c4c4c4;\n --accent-8: #afafaf;\n --accent-9: #404040;\n --accent-10: #515151;\n --accent-11: #6c6c6c;\n --accent-12: #383838;\n --accent-a1: #00000002;\n --accent-a2: #00000005;\n --accent-a3: #0000000d;\n --accent-a4: #00000016;\n --accent-a5: #0000001f;\n --accent-a6: #0000002c;\n --accent-a7: #0000003b;\n --accent-a8: #00000050;\n --accent-a9: #000000bf;\n --accent-a10: #000000ae;\n --accent-a11: #00000093;\n --accent-a12: #000000c7;\n --accent-surface: #f9f9f9cc;\n --gray-surface: #ffffffcc;\n --accent: 64, 64, 64;\n --accent-aa: 64, 64, 64;\n --accent-aaa: 64, 64, 64;\n --accent-tinted: 51, 51, 51;\n --background: 255, 255, 255;\n --accent-contrast: rgb(255, 255, 255);\n --bg-color-card: rgba(255, 255, 255, 0.7);\n --sidebar-background: rgb(255, 255, 255);\n --header-background: rgb(255, 255, 255);\n --border: var(--grayscale-a4);\n --border-concealed: var(--grayscale-a2);\n --body-text: 0, 0, 0;\n --body-text-inverted: 255, 255, 255;\n}\n\n@media (max-width: 1024px) {\n :root {\n --spacing-header-height: 5.875rem;\n --spacing-header-height-padded: 66px;\n }\n}\n\n\n:is(.dark) {\n --grayscale-1: var(--gray-1);\n --grayscale-2: var(--gray-2);\n --grayscale-3: var(--gray-3);\n --grayscale-4: var(--gray-4);\n --grayscale-5: var(--gray-5);\n --grayscale-6: var(--gray-6);\n --grayscale-7: var(--gray-7);\n --grayscale-8: var(--gray-8);\n --grayscale-9: var(--gray-9);\n --grayscale-10: var(--gray-10);\n --grayscale-11: var(--gray-11);\n --grayscale-12: var(--gray-12);\n --grayscale-a1: var(--gray-a1);\n --grayscale-a2: var(--gray-a2);\n --grayscale-a3: var(--gray-a3);\n --grayscale-a4: var(--gray-a4);\n --grayscale-a5: var(--gray-a5);\n --grayscale-a6: var(--gray-a6);\n --grayscale-a7: var(--gray-a7);\n --grayscale-a8: var(--gray-a8);\n --grayscale-a9: var(--gray-a9);\n --grayscale-a10: var(--gray-a10);\n --grayscale-a11: var(--gray-a11);\n --grayscale-a12: var(--gray-a12);\n --accent-1: #1e1e1e;\n --accent-2: #252525;\n --accent-3: #2d2d2d;\n --accent-4: #343434;\n --accent-5: #3b3b3b;\n --accent-6: #454545;\n --accent-7: #525252;\n --accent-8: #686868;\n --accent-9: #e0e0e0;\n --accent-10: #d6d6d6;\n --accent-11: #bababa;\n --accent-12: #e7e7e7;\n --accent-a1: #00000000;\n --accent-a2: #ffffff08;\n --accent-a3: #ffffff11;\n --accent-a4: #ffffff19;\n --accent-a5: #ffffff21;\n --accent-a6: #ffffff2c;\n --accent-a7: #ffffff3b;\n --accent-a8: #ffffff54;\n --accent-a9: #ffffffdc;\n --accent-a10: #ffffffd1;\n --accent-a11: #ffffffb1;\n --accent-a12: #ffffffe4;\n --accent-surface: color(display-p3 0.1725 0.1725 0.1725 / 0.5);\n --gray-surface: color(display-p3 0 0 0 / 5%);\n --accent: 224, 224, 224;\n --accent-aa: 224, 224, 224;\n --accent-aaa: 224, 224, 224;\n --accent-tinted: 237, 237, 237;\n --background: 30, 30, 30;\n --accent-contrast: rgb(49, 25, 33);\n --bg-color-card: rgba(25, 25, 25, 0.5);\n --bg-color-card-solid: rgb(27, 27, 27);\n --sidebar-background: rgb(8, 9, 10);\n --header-background: rgb(8, 9, 10);\n --border: var(--grayscale-a4);\n --border-concealed: var(--grayscale-a2);\n --body-text: 255, 255, 255;\n --body-text-inverted: 0, 0, 0;\n}\n\n\n\nhtml {\n background-color: #ffffff;\n}\n\nhtml.dark {\n background-color: #1e1e1e;\n}\n\n\n\n/* Hide branding */\n.mx-auto.my-8.w-fit {\n display: none !important;\n}\n\n/* Hide first HR in changelog */\n.fern-changelog \u003e main \u003e section + hr {\n display: none;\n}\n\n/* Make changelog entries center aligned */\n.fern-changelog \u003e main {\n margin-left: auto !important;\n margin-right: auto !important;\n overflow-wrap: break-word;\n width: 100%;\n}\n.fern-changelog-entry {\n justify-content: center !important;\n}\n\n/* Reduce padding on first changelog entry */\n.fern-changelog \u003e main \u003e section.fern-changelog-entry {\n padding-bottom: 0px;\n}\n\n/* Hide the docs sidebar tab icons container */\n.flex.min-w-0.items-center.justify-start.space-x-4 \u003e .min-w-fit {\n display: none !important;\n position: absolute !important;\n visibility: hidden !important;\n}\n\n.flex.min-w-0.items-center.justify-start.space-x-4 \u003e span {\n margin-left: 0 !important;\n}\n\n/* Fix the tablist not being scrollable on mobile and hide the native scrollbar */\n[role='tablist'] {\n position: relative;\n overflow-x: auto;\n overflow-y: visible;\n\n /* Hide native scrollbars */\n -ms-overflow-style: none;\n scrollbar-width: none;\n}\n[role='tablist']::-webkit-scrollbar {\n display: none; /* Chrome, Safari, newer Edge */\n}\n[role='tablist'] h6[data-state='active'] {\n position: relative;\n z-index: 1;\n border-bottom: 2px solid currentColor !important;\n}\n\n/*----------------------------------------\n Wave Animation Block\n----------------------------------------*/\n/* Overview Wave */\n#overview-wave {\n width: 100vw;\n overflow: hidden !important;\n overflow-x: hidden !important;\n height: 350px;\n margin-left: 50%;\n transform: translateX(-50%);\n}\n\n#overview-wave canvas[data-engine='three.js r171'] {\n height: 350px !important;\n}\n\n.light-mode-wave {\n display: none;\n}\n\n.dark-mode-wave {\n display: none;\n}\n\n:root[class='light'] .light-mode-wave {\n display: block;\n}\n\n:root[class='dark'] .dark-mode-wave {\n display: block;\n}\n\n.fern-sidebar-heading-content {\n font-size: 0.75rem !important;\n line-height: 1rem !important;\n}\n\n@media (min-width: 1024px) {\n elevenlabs-convai {\n display: block;\n }\n .fern-sidebar-heading {\n min-height: 30px !important;\n }\n}\n/* Make active sidebar links bolder with transition */\n.fern-sidebar-link-container .fern-sidebar-link-text {\n font-weight: 400;\n transition: font-weight 0.15s ease;\n}\n\n/* Active state styling */\n:root[class='light'] .fern-sidebar-link-container[data-state='active'] .fern-sidebar-link-text {\n font-weight: 500;\n color: #000000; /* or your preferred light mode active color */\n}\n\n:root[class='dark'] .fern-sidebar-link-container[data-state='active'] .fern-sidebar-link-text {\n font-weight: 500;\n color: #ffffff; /* or your preferred dark mode active color */\n}\n\n:root[class='light'] {\n --wave-color: blue;\n}\n\n:root[class='dark'] {\n --wave-color: gray;\n}\n\n/* Sidebar, header and header tabs styling */\n.clipped-background {\n background: none !important;\n opacity: 0 !important;\n}\n\n.fern-header,\n.fern-header-tabs {\n background-color: rgba(255, 255, 255, 0) !important;\n}\n\n.fern-sidebar-container,\n.fern-header-container {\n backdrop-filter: blur(10px);\n}\n\n.fern-header-container {\n border-bottom-color: rgb(233, 232, 234);\n border-bottom-style: solid;\n border-bottom-width: 1px;\n box-sizing: border-box;\n}\n\n:root[class='light'] .fern-sidebar-container,\n:root[class='light'] .fern-header-container {\n background-color: rgba(255, 255, 255, 0.9) !important;\n border-color: #e9e8ea !important;\n}\n\n:root[class='dark'] .fern-sidebar-container,\n:root[class='dark'] .fern-header-container {\n border-color: #23252a !important;\n background-color: rgba(0, 0, 0, 0.8);\n}\n\n/* Remove the bottom border on the header */\n.fern-header {\n border-bottom: none !important;\n}\n\n/* Fix the logo height */\n.fern-logo-container {\n height: 30px !important;\n}\n\n/* Bring TOC infront of the wave */\n.fern-layout-toc {\n z-index: 1 !important;\n}\n\n","featureFlagsConfig":{}},"__N_SSG":true},"page":"/static/[domain]/[[...slug]]","query":{"domain":"elevenlabs.io","slug":["docs","api-reference","introduction"]},"buildId":"gASoyzmfnGsTVn-yBp1nS","assetPrefix":"https://app.buildwithfern.com","isFallback":false,"isExperimentalCompile":false,"dynamicIds":[58494,47191,49326,27532,98508,85288,51687,7575,82359],"gsp":true,"scriptLoader":[]}</script></body></html>