Self Service Licensing & Credentials

<!DOCTYPE html><html lang="en" style="" data-color-mode="dark" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1734475815030"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.250.0"><meta name="readme-subdomain" content="api-beta-deepgram"><meta name="readme-version" content="1.0"><title>Self Service Licensing & Credentials</title><meta name="description" content="Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API."><meta property="og:title" content="Self-Hosted Deployment with Deepgram Using Self Service"><meta property="og:description" content="Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API."><meta property="og:site_name" content="Deepgram Docs"><meta name="twitter:title" content="Self-Hosted Deployment with Deepgram Using Self Service"><meta name="twitter:description" content="Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><meta name="twitter:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/f5d488e-small-icon-192x192.png" type="image/png"><link rel="canonical" href="https://developers.deepgram.com/docs/self-hosted-self-service-tutorial"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1734475815030"></script><link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3c3bbb6f7270425fb0a7.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.7ec459657ed5da592ee9.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.da5397756d5a59905ba1.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.71f8e165da2804376b62.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.18d649b81d088ccf8fe7.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.ad529c3d39e40f72e3f8.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.684e6481786a2c9a53de.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.e8c079b3df984cab2b40.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.b705fc2010420612d252.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.5f04db368eee8f70d81b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/697.c7df71558ebc8a75b523.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/73.c91a16995ea193a8705d.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/777.62bdcb0e49d755651783.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3108.471d4a1c3077afe27478.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.c1a2ae7970da644925ea.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.f038db7b1e3ac1460fe5.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.21bfe108dc2a9fd8187f.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.9d9eb8df4877b777c42d.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.9802bfeceb2dceb6e206.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.0a317d4e2bf3cde90317.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.cef380c3e211d2ea6e51.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.979bb00f878b2fa579a6.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.62f576269c8b3253048f.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.3ccf9f42effebdfd9cbf.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9553.cb407a77300a2dd958e4.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e58189ce91340b95c433.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d035c3329df9585fa7d6.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.b74c02c4ec3b054bb9d5.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.071c7febd301fb6e2a4d.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.c5776db0e83892adab6f.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.2deb29c12d09bcad8fb2.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.879f8fb13a34fcccd2a3.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.05c5c00809eab74a8061.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.e0529587af8819bc68f0.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.2edfa94f1d90a641f339.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.54cd06e135d3ee0dbc93.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.18d649b81d088ccf8fe7.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.71f8e165da2804376b62.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.da5397756d5a59905ba1.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.7ec459657ed5da592ee9.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3c3bbb6f7270425fb0a7.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"><style title="rm-custom-css">:root{--project-color-primary:#101014;--project-color-inverse:#fff;--recipe-button-color:#00E878;--recipe-button-color-hover:#008243;--recipe-button-color-active:#004f29;--recipe-button-color-focus:rgba(0, 232, 120, 0.25);--recipe-button-color-disabled:#b5ffdb}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#101014;--project-color-inverse:#fff}a{color:var(--color-link-primary,#00e878)}a:hover{color:var(--color-link-primary-darken-5,#008243)}a.text-muted:hover{color:var(--color-link-primary,#00e878)}.btn.btn-primary{background-color:#00e878}.btn.btn-primary:hover{background-color:#008243}.theme-line #hub-landing-top h2{color:#00e878}#hub-landing-top .btn:hover{color:#00e878}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#101014}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#101014,#000)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#101014}.theme-line header#hub-header #header-top .btn{background-color:#101014}header#hub-header #header-top #header-logo{width:260px;height:38px;margin-top:1px;background-image:url(https://files.readme.io/c96cd09-Docs_logo.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#101014}#subheader-links a.active{color:#101014!important;box-shadow:inset 0 -2px 0 #101014}#subheader-links a:hover{color:#101014!important;box-shadow:inset 0 -2px 0 #101014;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#00e878}section#hub-discuss .discussion a .discuss-body h4{color:#00e878}section#hub-discuss .discussion a:hover .discuss-body h4{color:#008243}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#00e878}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#00e878}#hub-search-results h3 em{color:#00e878}.main_background,.tag-item{background:#00e878!important}.main_background:hover{background:#008243!important}.main_color{color:#101014!important}.border_bottom_main_color{border-bottom:2px solid #101014}.main_color_hover:hover{color:#101014!important}section#hub-discuss h1{color:#00e878}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#00e878;background-color:#00e878}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#008243;border-color:#008243}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#00e878;color:#00e878}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#00e878);border-color:var(--project-color-primary,#00e878)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#008243;border-color:#008243}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#00e878;fill:var(--project-color-primary,#00e878)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#00e878}.main-color-accent{border-bottom:3px solid #101014;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES *//*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="api-beta-deepgram"> <meta property="og:type" content="website"> <meta property="og:image" content="https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp"> <meta property="twitter:card" content="summary_large_image"> <meta property="twitter:image" content="https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp">  <script src="https://kit.fontawesome.com/8c4f55fa20.js" crossorigin="anonymous"></script> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:100,100i,300,300i,400,400i,500,500i,700,700i,900,900i" type="text/css">  <script src="https://deepgram-devs.github.io/docs-cdn/script.js"></script> <link rel="stylesheet" href="https://deepgram-devs.github.io/docs-cdn/style.css" type="text/css"> <link rel="manifest" href="https://deepgram-devs.github.io/docs-cdn/manifest.json" type="application/json"> <link rel="shortcut icon" href="https://deepgram-devs.github.io/docs-cdn/favicon.ico" type="image/x-icon">  <script nonce="{{=it.nonce}}"> (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-M5WQMGR'); </script>   <script nonce="{{=it.nonce}}"> window['_fs_debug'] = false; window['_fs_host'] = 'fullstory.com'; window['_fs_script'] = 'edge.fullstory.com/s/fs.js'; window['_fs_org'] = '5HWAN'; window['_fs_namespace'] = 'FS'; (function(m,n,e,t,l,o,g,y){ if (e in m) {if(m.console && m.console.log) { m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');} return;} g=m[e]=function(a,b,s){g.q?g.q.push([a,b,s]):g._api(a,b,s);};g.q=[]; o=n.createElement(t);o.async=1;o.crossOrigin='anonymous';o.src='https://'+_fs_script; y=n.getElementsByTagName(t)[0];y.parentNode.insertBefore(o,y); g.identify=function(i,v,s){g(l,{uid:i},s);if(v)g(l,v,s)};g.setUserVars=function(v,s){g(l,v,s)};g.event=function(i,v,s){g('event',{n:i,p:v},s)}; g.anonymize=function(){g.identify(!!0)}; g.shutdown=function(){g("rec",!1)};g.restart=function(){g("rec",!0)}; g.log = function(a,b){g("log",[a,b])}; g.consent=function(a){g("consent",!arguments.length||a)}; g.identifyAccount=function(i,v){o='account';v=v||{};v.acctId=i;g(o,v)}; g.clearUserCookie=function(){}; g.setVars=function(n, p){g('setVars',[n,p]);}; g._w={};y='XMLHttpRequest';g._w[y]=m[y];y='fetch';g._w[y]=m[y]; if(m[y])m[y]=function(){return g._w[y].apply(this,arguments)}; g._v="1.3.0"; })(window,document,window['_fs_namespace'],'script','user'); </script>   <script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-user-analytics-fingerprint-enabled="true" data-website-id="f5c1c9d4-b072-4c91-8da2-231cc5ea31d2" data-project-name="Deepgram" data-modal-title="Get AI Powered Help Using Deepgram" data-project-color="#EB038F" data-project-logo="https://media.licdn.com/dms/image/D560BAQEaRN1vSzE2Ng/company-logo_200_200/0/1680904416780/deepgram_logo?e=2147483647&v=beta&t=YFDv1MdWVSsq1yknvJ0cD3Acvvi02d6pV1IDiUzA5MA" data-modal-disclaimer="This is a custom LLM for answering questions about Deepgram. Answers are based on the contents of Deepgram's: Documentation, API reference, Code Samples, Help Center and SDKs." ></script> <script>var storedColorMode = `dark` === 'system' ? window.localStorage.getItem('color-scheme') : `dark` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.250.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-dark "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#101014;--color-primary-inverse:#fff;--color-primary-alt:#000000;--color-primary-darken-10:#000000;--color-primary-darken-20:#000000;--color-primary-alpha-25:rgba(16, 16, 20, 0.25);--color-link-primary:#00E878;--color-link-primary-darken-5:#00ce6b;--color-link-primary-darken-10:#00b55e;--color-link-primary-darken-20:#008243;--color-link-primary-alpha-50:rgba(0, 232, 120, 0.5);--color-link-primary-alpha-25:rgba(0, 232, 120, 0.25);--color-link-background:rgba(0, 232, 120, 0.09);--color-link-text:#384248;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/docs" target="_self"><img alt="Deepgram Docs" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/c96cd09-Docs_logo.svg"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Documentation</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/recipes" target="_self"><i class="icon-recipes NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Recipes</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="https://community.deepgram.com/" rel="noopener" target="_blank" to="https://community.deepgram.com/"><span class="NavItem-textSlZuuL489uiw">Community</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="https://playground.deepgram.com" rel="noopener" target="_blank" to="https://playground.deepgram.com"><span class="NavItem-textSlZuuL489uiw">API Playground</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="https://deepgram.com/learn" rel="noopener" target="_blank" to="https://deepgram.com/learn"><span class="NavItem-textSlZuuL489uiw">Blog</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="https://status.deepgram.com/" rel="noopener" target="_blank" to="https://status.deepgram.com/"><span class="NavItem-textSlZuuL489uiw">Status</span></a><div class="NavItem-item1gDDTqaXGhm1 NavItem-item_inactiveMQoyhN045qAn">v1.0</div><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://console.deepgram.com/signup?jump=keys" rel="noopener" target="_blank" to="https://console.deepgram.com/signup?jump=keys">Free API Key</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/docs" target="_self"><img alt="Deepgram Docs" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/c96cd09-Docs_logo.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Documentation</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://console.deepgram.com/signup?jump=keys" target="_self" to="https://console.deepgram.com/signup?jump=keys">Free API Key</a></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><span class="undefined NavItem_inactive1YE6SGanIJp5 rm-Header-bottom-link">v1.0</span><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Documentation</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/recipes" target="_self"><i class="icon-recipes"></i><span>Recipes</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="https://community.deepgram.com/" target="_self" to="https://community.deepgram.com/"><span>Community</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="https://playground.deepgram.com" target="_self" to="https://playground.deepgram.com"><span>API Playground</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="https://deepgram.com/learn" target="_self" to="https://deepgram.com/learn"><span>Blog</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="https://status.deepgram.com/" target="_self" to="https://status.deepgram.com/"><span>Status</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Self Service Licensing & Credentials</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Deepgram Docs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/support"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Support</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Speech To Text</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-pre-recorded-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Pre-Recorded Audio" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pre-Recorded Audio</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-pre-recorded-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/stt-pre-recorded-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/stt-pre-recorded-starter-apps"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Starter Apps</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/automatically-generating-webvtt-and-srt-captions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Tips and Tricks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Tips and Tricks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/automatically-generating-webvtt-and-srt-captions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Automatically Generating WebVTT & SRT Captions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/automatically-transcribing-and-summarizing-phone-calls"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Automatically Transcribe and Summarize Phone Calls</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deepgram-whisper-cloud"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started with Deepgram Whisper Cloud</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/generating-and-saving-transcripts-from-the-terminal"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Generating and Saving Transcripts From the Terminal</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-callbacks-to-return-transcripts-to-your-server"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Callbacks to Return Transcripts to Your Server</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/payload-too-large"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">When Callback Is Not Received</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/multichannel-vs-diarization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">When To Use Multichannel and Diarization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/keywords-vs-search"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">When To Use Keywords and Search</span></span></a></li></ul></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-live-streaming-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Streaming Audio" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Streaming Audio</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-live-streaming-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/stt-streaming-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-the-streaming-test-suite"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Streaming Starter Kit</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/stt-streaming-starter-apps"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Starter Apps</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/close-stream"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Control Messages" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Control Messages</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/close-stream"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Close Stream</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/finalize"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Finalize</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/audio-keep-alive"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Audio Keep Alive</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/speech-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Speech Detection" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Speech Detection</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/speech-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Speech Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/utterance-end"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Utterance End</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/endpointing"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Endpointing</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/interim-results"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Interim Results</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/understanding-end-of-speech-detection"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Tips and Tricks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Tips and Tricks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/understanding-end-of-speech-detection"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">End of Speech Detection While Live Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-interim-results"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Interim Results</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/understand-endpointing-interim-results"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Endpointing & Interim Results With Live Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/determining-your-audio-format-for-live-streaming-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Determining Your Audio Format for Live Streaming Audio</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/measuring-streaming-latency"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Measuring Streaming Latency</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/troubleshooting-websocket-data-and-net-errors-when-live-streaming-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">WebSocket DATA & NET Errors When Live Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/recovering-from-connection-errors-and-timeouts-when-live-streaming-audio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Recovering From Connection Errors & Timeouts When Live Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/lower-level-websockets"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Lower-Level Websockets with the Streaming API</span></span></a></li></ul></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/models-languages-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Models and Languages" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Models and Languages</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/models-languages-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Models & Languages Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/language"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Languages Support</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/language-detection"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Language Detection</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/multilingual-code-switching"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Multilingual Code-Switching</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/model"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Model Options</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/version"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Version</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/diarization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Formatting" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Formatting</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/diarization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Diarization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dictation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Dictation</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/filler-words"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Filler Words</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/measurements"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Measurements</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/numerals"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Numerals</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/paragraphs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Paragraphs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/profanity-filter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Profanity Filtering</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/punctuation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Punctuation</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/redaction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Redaction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/smart-format"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Smart Formatting</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/supported-entity-types"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Supported Entity Types</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/utterances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Utterances</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/utterance-split"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Utterance Split</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/find-and-replace"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Custom Vocabulary" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Custom Vocabulary</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/find-and-replace"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Find and Replace</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/keywords"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Keywords</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/search"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/media-input-settings"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Media Input Settings" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Media Input Settings</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/channels"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Channels</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/encoding"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Encoding</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/multichannel"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Multichannel</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/sample-rate"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sample Rate</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/callback"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Results Processing" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Results Processing</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/callback"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">STT Callback</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tagging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Tagging</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/extra-metadata"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Extra Metadata</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">TEXT TO SPEECH</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-rest"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text-to-Speech REST" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text-to-Speech REST</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-callback"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">TTS Callback</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/streaming-the-audio-output"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Audio Output Streaming</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-websocket"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text-to-Speech Streaming" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text-to-Speech Streaming</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/streaming-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-streaming-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-ws-flush"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Control Messages" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Control Messages</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-ws-flush"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Flush</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-ws-clear"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Clear</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-ws-close"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Close</span></span></a></li></ul></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-starter-apps"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Starter Apps</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-models"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voice Selection</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-media-output-settings"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Media Output Settings" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Media Output Settings</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-encoding"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Encoding</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-bit-rate"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Bit Rate</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-container"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Container</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/tts-sample-rate"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sample Rate</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/handling-audio-issues-in-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Tips and Tricks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Tips and Tricks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/handling-audio-issues-in-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Handling Audio Issues in Text To Speech</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/send-llm-outputs-to-the-tts-web-socket"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sending LLM Outputs to a WebSocket</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-chunking-for-tts-streaming-optimization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text Chunking for Streaming TTS Optimization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-chunking-for-tts-optimization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text Chunking for TTS REST Optimization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-to-speech-latency"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech Latency</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-to-speech-prompting"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech Prompting</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Voice Agent</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-settings-configuration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Inputs: Client Messages" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inputs: Client Messages</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-settings-configuration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Settings Configuration</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-update-instructions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update Instructions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-update-speak"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Update Speak</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-inject-agent-message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Inject Agent Message</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-function-call-response"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Function Call Response</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/agent-keep-alive"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Keep Alive</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-welcome-message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Outputs: Server Messages" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Outputs: Server Messages</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-welcome-message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Welcome</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-setting-applied-message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Setting Applied</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-conversation-context"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Conversation Context</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-conversation-text"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Conversation Text</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-user-started-speaking"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">User Started Speaking</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-agent-thinking"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Thinking</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-function-call-request"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Function Call Request</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-function-calling-message"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Function Calling Message</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-agent-started-speaking"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Started Speaking</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-agent-audio-done"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Audio Done</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-server-errors"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Server Errors</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-llm-models"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent LLM Models</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-media-inputs-outputs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Agent Media Inputs & Outputs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-audio-playback"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Tips & Tricks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Tips & Tricks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-audio-playback"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voice Agent Audio & Playback</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agents-function-calling"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Function Calling with Voice Agents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/voice-agent-echo-cancellation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Voice Agent Adaptive Echo Cancellation</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Intelligence</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/audio-intelligence"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Audio Intelligence" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Audio Intelligence</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/audio-intelligence"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/stt-intelligence-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/detect-entities"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Entity Detection</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/intent-recognition"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Intent Recognition</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/sentiment-analysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sentiment Analysis</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/summarization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Summarization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/topic-detection"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Topic Detection</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/text-intelligence"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Text Intelligence" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text Intelligence</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-intelligence"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-intelligence-feature-overview"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Feature Overview</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-intention-recognition"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Intent Recognition</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-sentiment-analysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sentiment Analysis</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-summarization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Summarization</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/text-topic-detection"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Topic Detection</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Guides</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/make-your-first-api-request"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Fundamentals" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Fundamentals</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/make-your-first-api-request"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Make Your First API Request</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/authenticating"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authenticating</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/model-metadata"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Model Metadata</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/managing-projects"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Managing Projects</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-multiple-projects"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Multiple Projects</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/working-with-roles"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Working With Roles & API Scopes</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/supported-audio-formats"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Supported Audio Formats</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deployment-options"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deployment Options</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/create-additional-api-keys"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Creating API Keys</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-the-sec-websocket-protocol"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using the Sec-WebSocket-Protocol</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-logs-usage"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Logs & Usage Data</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/the-deepgram-model-improvement-partnership-program"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The Deepgram Model Improvement Partnership Program</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/working-with-concurrency-rate-limits"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Working With Concurrency Rate Limits</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://developers.deepgram.com/reference/api-rate-limits"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">API Rate Limits</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-from-amazon-web-services-aws-transcribe-to-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Migrating" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Migrating</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-from-amazon-web-services-aws-transcribe-to-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Migrating From Amazon Web Services (AWS) Transcribe to Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-from-google-speech-to-text-stt-to-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Migrating From Google Speech-to-Text (STT) to Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-from-openai-whisper-to-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Migrating From OpenAI Whisper to Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-from-assembly-ai-speech-to-text-to-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Migrating from AssemblyAI Speech-to-Text to Deepgram</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/build-voice-agent-with-twilio-deepgram-openai"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Use Case Examples" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Use Case Examples</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/build-voice-agent-with-twilio-deepgram-openai"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Build a Voice Agent with Twilio & OpenAI & Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/calculate-talk-time-analytics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Calculate Talk Time Analytics</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/transcribe-meetings-in-realtime"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transcribe Meetings in Realtime</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/transcribe-recorded-calls-with-twilio"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transcribe Recorded Calls With Twilio</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/deepgram-with-amazon-connect"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Integrations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Integrations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deepgram-with-amazon-connect"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Amazon Connect and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-aws-s3-presigned-urls-with-the-deepgram-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">AWS S3 Presigned URLs and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/genesys-with-deepgram"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Genesys and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/use-deepgram-with-dialogflow-cx"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Dialogflow CX and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/makecom-deepgram-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Make.com and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/on-premise-twilio-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Twilio and Deepgram STT</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/twilio-and-deepgram-tts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Twilio and Deepgram TTS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/zapier-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Zapier and Deepgram</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/integrate-deepgram-with-zoom"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Zoom and Deepgram</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">SDKS</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/deepgram-sdks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deepgram SDKs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/sdk-feature-matrix"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">SDK Feature Matrix</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/using-custom-parameters-sdks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Custom Add On Parameters with SDKs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/using-custom-headers-and-sdks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Custom Headers with SDKs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/using-client-options-with-sdks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Client Options with SDKs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/js-sdk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for JavaScript SDK" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">JavaScript SDK</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/js-sdk-v2-to-v3-migration-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">JavaScript SDK V2 to V3 Migration Guide</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/node-sdk-pre-recorded-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pre-Recorded Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/node-sdk-streaming-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Streaming Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/js-sdk-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech REST</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/js-sdk-streaming-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech Streaming</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Python SDK" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Python SDK</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk-v2-to-v3-migration-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Python SDK V2 to V3 Migration Guide</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/threaded-and-async-io-task-support"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Threaded and Async IO Task Support</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk-pre-recorded-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pre-Recorded Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk-streaming-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Streaming Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text To Speech REST</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-sdk-streaming-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text To Speech Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/python-notebooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Python Notebooks</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for .NET SDK" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">.NET SDK</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk-v3-to-v4-migration-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">.NET SDK V3 to V4 Migration Guide</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk-pre-recorded-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pre-Recorded Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk-streaming-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Streaming Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech REST</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/dotnet-sdk-streaming-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text to Speech Streaming</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/go-sdk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Go SDK" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Go SDK</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/go-sdk-v12-to-v136-migration-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Go SDK v1.2 to v1.3 Interface Change</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/pre-recorded-audio-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pre-Recorded Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/live-streaming-audio-transcription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Live Streaming Audio Transcription</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/go-sdk-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text-to-Speech REST</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/go-sdk-streaming-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Text-to-Speech Streaming</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://pkg.go.dev/github.com/deepgram/deepgram-go-sdk@main"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Go SDK Docs</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://github.com/deepgram/deepgram-rust-sdk"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Rust SDK [community]</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://pub.dev/packages/deepgram_speech_to_text"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Flutter SDK [community]</span></span><i aria-hidden="true" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Self-Hosted Deployments</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/self-hosted-introduction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/self-hosted-deployment-environments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deployment Environments</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/dockerpodman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Docker/Podman" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Docker/Podman</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/aws-docker-podman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Platform Options" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Platform Options</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/aws-docker-podman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Amazon Web Services</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/gcp-docker-podman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Cloud Platform</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/oci-docker-podman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Oracle Cloud Infrastructure</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/azure-docker-podman"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Microsoft Azure</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/bare-metal"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Bare-Metal Servers</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/drivers-and-containerization-platforms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Drivers and Container Orchestration Tools</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deploy-deepgram-services"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deploy Deepgram Services</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/kubernetes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Kubernetes" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Kubernetes</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/aws-k8s"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Platform Options" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Platform Options</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/aws-k8s"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Amazon Web Services</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/gcp-k8s"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Cloud Platform</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/self-managed-kubernetes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Self-Managed Kubernetes</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/securing-your-cluster"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Securing Your Cluster</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/self-hosted-self-service-tutorial"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Self Service Licensing & Credentials</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/scaling-and-deployment-strategies"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Scaling and Deployment Strategies" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Scaling and Deployment Strategies</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/maintaining"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">System Maintenance</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/autoscaling-best-practices"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Auto-Scaling</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/metrics-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Metrics Guide</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/self-hosted-ingress-auth"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Ingress Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/using-private-container-registries"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using Private Container Registries</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/self-hosted-add-ons"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Self-Hosted Add Ons" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Self-Hosted Add Ons</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/license-proxy"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">License Proxy</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/self-hosted-text-to-speech"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Self-Hosted Text to Speech</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/prometheus-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Prometheus Integration</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/deepgram-unimrcp-plugin"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deepgram UniMRCP Plugin</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/using-sdks-with-self-hosted"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Using SDKs with Self-Hosted</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Security</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/security-policy"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Security Policy</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/data-privacy-compliance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data Privacy Compliance</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/information-security-privacy-statement"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Information Security & Privacy Statement</span></span></a></li></ul></section></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Self Service Licensing & Credentials</h1><div class="excerpt"><div class="rm-Markdown markdown-body" data-testid="RDMD"><p>Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API.</p></div></div></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/self-hosted-self-service-tutorial"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<p>Deepgram gives you the ability to self-manage your self-hosted API keys and container image distribution credentials. This offers you flexibility and control over your Deepgram self-hosted deployments using <a href="https://console.deepgram.com" target="" title="">Deepgram Console</a> and <a href="https://quay.io/" target="" title="">Quay</a>. For example, you can rotate and expire your keys and credentials according to your access control policies.</p> <p>This guide focuses on using Deepgram Console. If you would like to use the Deepgram API, see our API documentation on <a href="https://developers.deepgram.com/reference/create-key#deepgram-self-hosted-api-keys" target="" title="">creating API keys</a> and creating <a href="https://developers.deepgram.com/reference/create-credentials" target="" title="">distribution credentials</a>. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="verifying-access-to-self-hosted-products"></div><div class="heading-text"><div id="section-verifying-access-to-self-hosted-products" class="heading-anchor_backwardsCompatibility"></div>Verifying Access to Self-Hosted Products</div><a aria-label="Skip link to Verifying Access to Self-Hosted Products" class="heading-anchor-icon fa fa-anchor" href="#verifying-access-to-self-hosted-products"></a></h2> <p>This guide only applies to Console projects which have been granted access to self-hosted products. If you have access, your <a href="https://console.deepgram.com/login" target="" title="">Console</a> menu should have an &quot;Self-Hosted&quot; tab, as shown below.</p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/edd10ba-ps_2024-07-15_094100.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <p>If you do not have this tab in Console, your project has either:</p> <ol> <li>Never received access to self-hosted products <ol> <li>To take advantage of our self-hosted product offering, you will need to enroll in a <a href="https://deepgram.com/pricing" target="" title="">Deepgram Enterprise Plan</a>. If you&#x27;re interested, please <a href="https://deepgram.com/contact-us/" target="" title="">contact us</a>!</li> </ol> </li> <li>Received access to managed self-hosted products, but has not yet been granted access to self-service for these products. <ol> <li>Please contact your Deepgram Account Representative to enable access.</li> </ol> </li> </ol> <p>With that out of the way, we can begin!</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="create-a-self-hosted-api-key"></div><div class="heading-text"><div id="section-create-a-self-hosted-api-key" class="heading-anchor_backwardsCompatibility"></div>Create a Self-Hosted API Key</div><a aria-label="Skip link to Create a Self-Hosted API Key" class="heading-anchor-icon fa fa-anchor" href="#create-a-self-hosted-api-key"></a></h2> <p>You can use the <a href="https://console.deepgram.com/login" target="" title="">Deepgram Console</a> or the Deepgram API to create a self-hosted API key for licensing Deepgram products. Follow the <a href="/docs/create-additional-api-keys" target="" title="" class="doc-link" data-sidebar="create-additional-api-keys">Creating API Keys</a> guide to create a key, and record it securely.</p> <p>After receiving your key, you can dismiss the pop-up and return to the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">API Keys</code> page. You should see your new self-hosted API key, and if you expand the details, you can view the self-hosted products which can be licensed by that key.</p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/70047e9-ps_2024-07-15_095415.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <p>Depending on your self-hosted agreement with Deepgram, you may have access to different products. All self-hosted customers have access to API and Engine. For access to the <a href="/docs/license-proxy" target="" title="" class="doc-link" data-sidebar="license-proxy">License Proxy</a>, please contact <a href="https://deepgram.com/contact-us/" target="" title="">Support</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="create-container-image-distribution-credentials"></div><div class="heading-text"><div id="section-create-container-image-distribution-credentials" class="heading-anchor_backwardsCompatibility"></div>Create Container Image Distribution Credentials</div><a aria-label="Skip link to Create Container Image Distribution Credentials" class="heading-anchor-icon fa fa-anchor" href="#create-container-image-distribution-credentials"></a></h2> <p>Distribution credentials are used to authenticate with a container image repository when pulling Deepgram container images into your deployment environment.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading empty"><span class="callout-icon">📘</span></h2><p>Distribution credentials are <em>not</em> the same as self-hosted API keys. In our documentation, when we refer to an self-hosted API key (<button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">DEEPGRAM_API_KEY</code>), this is referring to the key made in the previous section.</p></blockquote> <br/> <ol> <li> <p>Back on the <a href="console.deepgram.com" target="" title="">Console</a> page, use the menu on the left and click on the &quot;Self-Hosted&quot; tab, then click &quot;Create New Distribution Credentials&quot;. </p> <p><span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/edd10ba-ps_2024-07-15_094100.png" align="" caption="" height="auto" title="" width="auto"/></span></span></p> </li> </ol> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/d0f206c-ps_2023-08-04_095150.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <ol start="2"> <li> <p>Provide a name for your distribution credentials and click &quot;Create Credentials&quot;. </p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/4c1ee36-ps_2024-07-15_095604.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> </li> <li> <p>Your new credentials will be shown, which include: </p> <ol> <li>A <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">username</code>, which looks like <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram+6ba7b810-9dad-11d1-80b4-00c04fd430c8</code>.</li> <li>A <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">secret</code>, which looks like <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">R2CTHDZ27R360V8H5LOWGBQ871HE9RP5YGWZA9JXWM3V98ST4VE3NYX72BK86Z7J</code>.</li> <li>An example <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">shell</code> command that demonstrates how to authenticate with your credentials</li> </ol> <p>You can use the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">secret</code> as your password for the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">shell</code> command. Again, take note of the displayed values, as they can&#x27;t be accessed again. Once you&#x27;ve copied it, check the box affirming you understand this and click &quot;Got it&quot;.</p> </li> </ol> <span aria-label="Distribution credentials limited secret access" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="Distribution credentials limited secret access" loading="lazy" src="https://files.readme.io/232d72f-Screenshot_2023-06-28_at_11.47.01_AM.png" align="center" class="" width="50% " caption="" height="auto" title=""/></span></span> <ol start="5"> <li> <p>The pop-up will be dismissed and you will be back on the &quot;Self-Hosted&quot; page. You should see your new distribution credentials and the container images which can be accessed with those credentials. </p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/09ea5d9-ps_2024-07-15_095816.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> </li> </ol> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="migration-for-legacy-licensing-and-container-distribution"></div><div class="heading-text"><div id="section-migration-for-legacy-licensing-and-container-distribution" class="heading-anchor_backwardsCompatibility"></div>Migration for Legacy Licensing and Container Distribution</div><a aria-label="Skip link to Migration for Legacy Licensing and Container Distribution" class="heading-anchor-icon fa fa-anchor" href="#migration-for-legacy-licensing-and-container-distribution"></a></h2> <blockquote class="callout callout_okay" theme="👍"><h2 class="callout-heading empty"><span class="callout-icon">👍</span></h2><p>If you are deploying Deepgram to your environment for the first time, you may skip this section and proceed to the next guide, linked at the bottom of the page.</p></blockquote> <p>If your self-hosted Deepgram environment uses a static legacy license key, or you previously used DockerHub to access container images, you will need to modify your environment to use your newly generated credentials.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>Checking if you need to migrate from DockerHub</p></h2><p>To check if you are currently pulling images from DockerHub and need to migrate to Quay, check your deployment files. Depending on your container orchestrator, this may be a Docker Compose file, a Podman Compose file, Kubernetes manifest files, or a Helm chart.</p><p>A container image path and tag will be listed within those files. If it looks like any of the following, you are pulling from DockerHub and must migrate to Quay.</p><ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-api:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-engine:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-license-proxy:xxxx</code></li> </ul><p>If your image tags have the prefix <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io</code>, such as some of the examples below, you are already using Quay and do not need to migrate.</p><ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-api:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-api:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-engine:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-engine:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-license-proxy:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-license-proxy:xxxx</code></li> </ul></blockquote> <ol> <li>Upgrade your Deepgram container images to the most recent release provided by Quay. <ol> <li>Login on the command line using the newly generated credentials from <a href="#create-container-images-distribution-credentials" target="" title="">Create Container Image Distribution Credentials</a>. </li> <li>Follow the instructions <a href="/docs/deploy-deepgram-services#pull-deepgram-container-images" target="" title="" class="doc-link" data-sidebar="deploy-deepgram-services#pull-deepgram-container-images">here</a> to pull the latest Deepgram images. </li> <li>Edit your <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">docker-compose.yml</code> file (or other orchestration platform files, like Kubernetes manifest files) to use the new container image you just pulled from Quay.</li> </ol> </li> <li>Replace your static legacy license key with your newly generated self-hosted API key from the <a href="#create-a-self-hosted-api-key" target="" title="">Create a Self-Hosted API Key</a> section. <ol> <li>Edit any custom <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">api.toml</code> and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">engine.toml</code> configuration files. Replace the value at <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">[license.key]</code> with your API key secret.</li> <li>If needed, edit the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">docker-compose.yml</code> file (or other orchestration platform files) to replace the key used by the License Proxy or other add-on products. Replace the value at <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">--license-key</code> with your API key secret.</li> </ol> </li> </ol>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><p>Deepgram gives you the ability to self-manage your self-hosted API keys and container image distribution credentials. This offers you flexibility and control over your Deepgram self-hosted deployments using <a target="_self" href="https://console.deepgram.com">Deepgram Console</a> and <a target="_self" href="https://quay.io/">Quay</a>. For example, you can rotate and expire your keys and credentials according to your access control policies.</p> <p>This guide focuses on using Deepgram Console. If you would like to use the Deepgram API, see our API documentation on <a target="_self" href="/reference/create-key#deepgram-self-hosted-api-keys">creating API keys</a> and creating <a target="_self" href="/reference/create-credentials">distribution credentials</a>. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="verifying-access-to-self-hosted-products"></div><div class="heading-text"><div id="section-verifying-access-to-self-hosted-products" class="heading-anchor_backwardsCompatibility"></div>Verifying Access to Self-Hosted Products</div><a aria-label="Skip link to Verifying Access to Self-Hosted Products" class="heading-anchor-icon fa fa-anchor" href="#verifying-access-to-self-hosted-products"></a></h2> <p>This guide only applies to Console projects which have been granted access to self-hosted products. If you have access, your <a target="_self" href="https://console.deepgram.com/login">Console</a> menu should have an "Self-Hosted" tab, as shown below.</p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/edd10ba-ps_2024-07-15_094100.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <p>If you do not have this tab in Console, your project has either:</p> <ol> <li>Never received access to self-hosted products <ol> <li>To take advantage of our self-hosted product offering, you will need to enroll in a <a target="_self" href="https://deepgram.com/pricing">Deepgram Enterprise Plan</a>. If you're interested, please <a target="_self" href="https://deepgram.com/contact-us/">contact us</a>!</li> </ol> </li> <li>Received access to managed self-hosted products, but has not yet been granted access to self-service for these products. <ol> <li>Please contact your Deepgram Account Representative to enable access.</li> </ol> </li> </ol> <p>With that out of the way, we can begin!</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="create-a-self-hosted-api-key"></div><div class="heading-text"><div id="section-create-a-self-hosted-api-key" class="heading-anchor_backwardsCompatibility"></div>Create a Self-Hosted API Key</div><a aria-label="Skip link to Create a Self-Hosted API Key" class="heading-anchor-icon fa fa-anchor" href="#create-a-self-hosted-api-key"></a></h2> <p>You can use the <a target="_self" href="https://console.deepgram.com/login">Deepgram Console</a> or the Deepgram API to create a self-hosted API key for licensing Deepgram products. Follow the <a target="_self" href="/docs/create-additional-api-keys">Creating API Keys</a> guide to create a key, and record it securely.</p> <p>After receiving your key, you can dismiss the pop-up and return to the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">API Keys</code> page. You should see your new self-hosted API key, and if you expand the details, you can view the self-hosted products which can be licensed by that key.</p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/70047e9-ps_2024-07-15_095415.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <p>Depending on your self-hosted agreement with Deepgram, you may have access to different products. All self-hosted customers have access to API and Engine. For access to the <a target="_self" href="/docs/license-proxy">License Proxy</a>, please contact <a target="_self" href="https://deepgram.com/contact-us/">Support</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="create-container-image-distribution-credentials"></div><div class="heading-text"><div id="section-create-container-image-distribution-credentials" class="heading-anchor_backwardsCompatibility"></div>Create Container Image Distribution Credentials</div><a aria-label="Skip link to Create Container Image Distribution Credentials" class="heading-anchor-icon fa fa-anchor" href="#create-container-image-distribution-credentials"></a></h2> <p>Distribution credentials are used to authenticate with a container image repository when pulling Deepgram container images into your deployment environment.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading empty"><span class="callout-icon">📘</span></h2><p>Distribution credentials are <em>not</em> the same as self-hosted API keys. In our documentation, when we refer to an self-hosted API key (<button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">DEEPGRAM_API_KEY</code>), this is referring to the key made in the previous section.</p></blockquote> <br/> <ol> <li> <p>Back on the <a target="_self" href="console.deepgram.com">Console</a> page, use the menu on the left and click on the "Self-Hosted" tab, then click "Create New Distribution Credentials". </p> <p><span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/edd10ba-ps_2024-07-15_094100.png" align="" caption="" height="auto" title="" width="auto"/></span></span></p> </li> </ol> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/d0f206c-ps_2023-08-04_095150.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> <ol start="2"> <li> <p>Provide a name for your distribution credentials and click "Create Credentials". </p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/4c1ee36-ps_2024-07-15_095604.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> </li> <li> <p>Your new credentials will be shown, which include: </p> <ol> <li>A <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">username</code>, which looks like <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram+6ba7b810-9dad-11d1-80b4-00c04fd430c8</code>.</li> <li>A <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">secret</code>, which looks like <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">R2CTHDZ27R360V8H5LOWGBQ871HE9RP5YGWZA9JXWM3V98ST4VE3NYX72BK86Z7J</code>.</li> <li>An example <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">shell</code> command that demonstrates how to authenticate with your credentials</li> </ol> <p>You can use the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">secret</code> as your password for the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">shell</code> command. Again, take note of the displayed values, as they can't be accessed again. Once you've copied it, check the box affirming you understand this and click "Got it".</p> </li> </ol> <span aria-label="Distribution credentials limited secret access" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="Distribution credentials limited secret access" loading="lazy" src="https://files.readme.io/232d72f-Screenshot_2023-06-28_at_11.47.01_AM.png" align="center" class="" width="50% " caption="" height="auto" title=""/></span></span> <ol start="5"> <li> <p>The pop-up will be dismissed and you will be back on the "Self-Hosted" page. You should see your new distribution credentials and the container images which can be accessed with those credentials. </p> <span aria-label="" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="" loading="lazy" src="https://files.readme.io/09ea5d9-ps_2024-07-15_095816.png" title="" align="center" class="" caption="" height="auto" width="auto"/></span></span> </li> </ol> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="migration-for-legacy-licensing-and-container-distribution"></div><div class="heading-text"><div id="section-migration-for-legacy-licensing-and-container-distribution" class="heading-anchor_backwardsCompatibility"></div>Migration for Legacy Licensing and Container Distribution</div><a aria-label="Skip link to Migration for Legacy Licensing and Container Distribution" class="heading-anchor-icon fa fa-anchor" href="#migration-for-legacy-licensing-and-container-distribution"></a></h2> <blockquote class="callout callout_okay" theme="👍"><h2 class="callout-heading empty"><span class="callout-icon">👍</span></h2><p>If you are deploying Deepgram to your environment for the first time, you may skip this section and proceed to the next guide, linked at the bottom of the page.</p></blockquote> <p>If your self-hosted Deepgram environment uses a static legacy license key, or you previously used DockerHub to access container images, you will need to modify your environment to use your newly generated credentials.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>Checking if you need to migrate from DockerHub</p></h2><p>To check if you are currently pulling images from DockerHub and need to migrate to Quay, check your deployment files. Depending on your container orchestrator, this may be a Docker Compose file, a Podman Compose file, Kubernetes manifest files, or a Helm chart.</p><p>A container image path and tag will be listed within those files. If it looks like any of the following, you are pulling from DockerHub and must migrate to Quay.</p><ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-api:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-engine:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">deepgram/onprem-license-proxy:xxxx</code></li> </ul><p>If your image tags have the prefix <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io</code>, such as some of the examples below, you are already using Quay and do not need to migrate.</p><ul> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-api:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-api:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-engine:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-engine:xxxx</code></li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/onprem-license-proxy:xxxx</code> </li> <li><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">quay.io/deepgram/self-hosted-license-proxy:xxxx</code></li> </ul></blockquote> <ol> <li>Upgrade your Deepgram container images to the most recent release provided by Quay. <ol> <li>Login on the command line using the newly generated credentials from <a target="_self" href="#create-container-images-distribution-credentials">Create Container Image Distribution Credentials</a>. </li> <li>Follow the instructions <a target="_self" href="/docs/deploy-deepgram-services#pull-deepgram-container-images">here</a> to pull the latest Deepgram images. </li> <li>Edit your <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">docker-compose.yml</code> file (or other orchestration platform files, like Kubernetes manifest files) to use the new container image you just pulled from Quay.</li> </ol> </li> <li>Replace your static legacy license key with your newly generated self-hosted API key from the <a target="_self" href="#create-a-self-hosted-api-key">Create a Self-Hosted API Key</a> section. <ol> <li>Edit any custom <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">api.toml</code> and <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">engine.toml</code> configuration files. Replace the value at <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">[license.key]</code> with your API key secret.</li> <li>If needed, edit the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">docker-compose.yml</code> file (or other orchestration platform files) to replace the key used by the License Proxy or other add-on products. Replace the value at <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">--license-key</code> with your API key secret.</li> </ol> </li> </ol></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated 4 days ago </p></div><hr class="NextStepsDivider"/><div class="WhatsNext-wrapper3DTnpcPqKoHg"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader WhatsNext-headingQHN33r4trf_s"><div class="APISectionHeader-heading4MUMLbp4_nLs">What’s Next</div></header><div class="rm-Markdown markdown-body WhatsNext-description1zZyZLPCGmaa" data-testid="RDMD"><p>Whether you are spinning up a new deployment environment, or modifying an existing environment to use your new self-service credentials, the next step is to deploy Deepgram services with your container orchestration tool of choice.</p></div><ul><li><a class="WhatsNext-link" href="https://developers.deepgram.com/docs/deploy-deepgram-services" target="blank">Deploy Deepgram with Docker/Podman</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-up-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M7 17 17 7M7 7h10v10" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" href="https://developers.deepgram.com/docs/kubernetes" target="blank">Deploy Deepgram with Kubernetes</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-up-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M7 17 17 7M7 7h10v10" class="icon-stroke-width"></path></svg></span></li></ul></div></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li><a href="#verifying-access-to-self-hosted-products">Verifying Access to Self-Hosted Products</a></li> <li><a href="#create-a-self-hosted-api-key">Create a Self-Hosted API Key</a></li> <li><a href="#create-container-image-distribution-credentials">Create Container Image Distribution Credentials</a></li> <li><a href="#migration-for-legacy-licensing-and-container-distribution">Migration for Legacy Licensing and Container Distribution</a></li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"64493f77eec9471292699395","title":"Deepgram Docs","slug":"introduction","order":0,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-26T15:12:55.657Z","__v":0,"pages":[{"_id":"64493f8878f8661413de60ea","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Introduction","icon":"","type":"basic","slug":"introduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"home","category":"64493f77eec9471292699395","createdAt":"2023-04-26T15:13:12.575Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65f8bb7892f0900010356f3f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Getting Started","icon":"","type":"basic","slug":"getting-started","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"64493f77eec9471292699395","createdAt":"2024-03-18T22:08:56.538Z","isBodyEmpty":false,"children":[]},{"_id":"644f9c2f5cd254005aa300a2","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Support","icon":"","type":"basic","slug":"support","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64493f77eec9471292699395","createdAt":"2023-05-01T11:02:07.543Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"65835c6c837d30002a8f700a","title":"Speech To Text","slug":"speech-to-text-pre-recorded","order":1,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-12-20T21:28:12.872Z","__v":0,"pages":[{"_id":"65b7e8f2b9f2690016f35c41","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pre-Recorded Audio","icon":"","type":"basic","slug":"pre-recorded","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2024-01-29T18:05:38.976Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643869357bf75600142a0ce7","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Getting Started","icon":"","type":"basic","slug":"getting-started-with-pre-recorded-audio","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7e8f2b9f2690016f35c41","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-13T20:42:29.911Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65837b9aff19a0001b32abc1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Feature Overview","icon":"","type":"basic","slug":"stt-pre-recorded-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"feature-overview-copy","parentDoc":"65b7e8f2b9f2690016f35c41","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-20T23:41:14.156Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65f8c636cca9c7006cabc7d7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Starter Apps","icon":"","type":"basic","slug":"stt-pre-recorded-starter-apps","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"starter-apps-1","parentDoc":"65b7e8f2b9f2690016f35c41","category":"65835c6c837d30002a8f700a","createdAt":"2024-03-18T22:54:46.843Z","isBodyEmpty":false,"children":[]},{"_id":"6584a5597bedcf006fad5e68","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Tips and Tricks","icon":"","type":"basic","slug":"pre-recorded-audio-tips-and-tricks","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tips-and-tricks-2","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T20:51:37.847Z","parentDoc":"65b7e8f2b9f2690016f35c41","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6440596a00146d000a57d56c","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Automatically Generating WebVTT & SRT Captions","icon":"","type":"basic","slug":"automatically-generating-webvtt-and-srt-captions","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T21:13:14.505Z","isBodyEmpty":false,"children":[]},{"_id":"64405a2c49a1c700415efcb8","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Automatically Transcribe and Summarize Phone Calls","icon":"","type":"basic","slug":"automatically-transcribing-and-summarizing-phone-calls","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T21:16:28.059Z","isBodyEmpty":false,"children":[]},{"_id":"644007ec6b966b001e53c7f6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Getting Started with Deepgram Whisper Cloud","icon":"","type":"basic","slug":"deepgram-whisper-cloud","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T15:25:32.962Z","isBodyEmpty":false,"children":[]},{"_id":"64401a9411b8db1b493ff5d4","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Generating and Saving Transcripts From the Terminal","icon":"","type":"basic","slug":"generating-and-saving-transcripts-from-the-terminal","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T16:45:08.924Z","isBodyEmpty":false,"children":[]},{"_id":"644057444b1c5a00246c170a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Using Callbacks to Return Transcripts to Your Server","icon":"","type":"basic","slug":"using-callbacks-to-return-transcripts-to-your-server","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T21:04:04.662Z","isBodyEmpty":false,"children":[]},{"_id":"647118cff7a2c2003b6df182","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"When Callback Is Not Received","icon":"","type":"basic","slug":"payload-too-large","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-payload-too-large","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-05-26T20:38:39.140Z","isBodyEmpty":false,"children":[]},{"_id":"644190f0a867320030d433a3","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"When To Use Multichannel and Diarization","icon":"","type":"basic","slug":"multichannel-vs-diarization","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"understanding-when-to-use-the-multichannel-and-diarization-features","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-20T19:22:24.543Z","parentDoc":"6584a5597bedcf006fad5e68","isBodyEmpty":false,"children":[]},{"_id":"644191847f087d003151e5ad","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"When To Use Keywords and Search","icon":"","type":"basic","slug":"keywords-vs-search","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a5597bedcf006fad5e68","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-20T19:24:52.902Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65b7ea56449649005728a6cd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Streaming Audio","icon":"","type":"basic","slug":"streaming","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2024-01-29T18:11:34.410Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"64401b06edbeaf1b81ccffab","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Getting Started","icon":"","type":"basic","slug":"getting-started-with-live-streaming-audio","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ea56449649005728a6cd","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T16:47:02.061Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65836caf28c86b0080783a7c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Feature Overview","icon":"","type":"basic","slug":"stt-streaming-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sst-streaming-feature-overview","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-20T22:37:35.594Z","parentDoc":"65b7ea56449649005728a6cd","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"644052b697708f0025c42e18","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Live Streaming Starter Kit","icon":"","type":"basic","slug":"getting-started-with-the-streaming-test-suite","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ea56449649005728a6cd","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T20:44:38.538Z","isBodyEmpty":false,"children":[]},{"_id":"65f8c6e63c3c55001f49055c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Starter Apps","icon":"","type":"basic","slug":"stt-streaming-starter-apps","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"starter-apps-copy","parentDoc":"65b7ea56449649005728a6cd","category":"65835c6c837d30002a8f700a","createdAt":"2024-03-18T22:57:42.880Z","isBodyEmpty":false,"children":[]},{"_id":"669ef4fda4d191002b855ebc","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Control Messages","icon":"","type":"basic","slug":"stt-control-messages","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"control-messages","parentDoc":"65b7ea56449649005728a6cd","category":"65835c6c837d30002a8f700a","createdAt":"2024-07-23T00:10:37.314Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"66d0f66875ceb00011ca27db","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Close Stream","icon":"","type":"basic","slug":"close-stream","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"closestream","parentDoc":"669ef4fda4d191002b855ebc","category":"65835c6c837d30002a8f700a","createdAt":"2024-08-29T22:30:00.133Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"669eb028a1df470010003178","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Finalize","icon":"","type":"basic","slug":"finalize","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"real-time-finalize","parentDoc":"669ef4fda4d191002b855ebc","category":"65835c6c837d30002a8f700a","createdAt":"2024-07-22T19:16:56.492Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6607182c17f5f100254c438b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Audio Keep Alive","icon":"","type":"basic","slug":"audio-keep-alive","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"keep-alive","parentDoc":"669ef4fda4d191002b855ebc","category":"65835c6c837d30002a8f700a","createdAt":"2024-03-29T19:36:12.218Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"662199db11c3240010ac320c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Speech Detection","icon":"","type":"basic","slug":"speech-detection","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ea56449649005728a6cd","category":"65835c6c837d30002a8f700a","createdAt":"2024-04-18T22:08:27.425Z","isBodyEmpty":true,"children":[{"_id":"65c3c73cb8a0410052c3b1bc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Speech Started","icon":"","type":"basic","slug":"speech-started","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"662199db11c3240010ac320c","category":"65835c6c837d30002a8f700a","createdAt":"2024-02-07T18:09:00.953Z","isBodyEmpty":false,"children":[]},{"_id":"65c294cc0e77f40053b7885c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Utterance End","icon":"","type":"basic","slug":"utterance-end","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"662199db11c3240010ac320c","category":"65835c6c837d30002a8f700a","createdAt":"2024-02-06T20:21:32.109Z","isBodyEmpty":false,"children":[]},{"_id":"643ea512296c120020684174","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Endpointing","icon":"","type":"basic","slug":"endpointing","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"662199db11c3240010ac320c","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:11:30.457Z","isBodyEmpty":false,"children":[]},{"_id":"643ea59d77cd3412d34a0ba3","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Interim Results","icon":"","type":"basic","slug":"interim-results","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"662199db11c3240010ac320c","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:13:49.576Z","isBodyEmpty":false,"children":[]}]},{"_id":"6584a356a38e25004c2cdf43","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Tips and Tricks","icon":"","type":"basic","slug":"streaming-audio-tips-and-tricks","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tips-and-tricks-1","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T20:43:02.453Z","parentDoc":"65b7ea56449649005728a6cd","mdx":{},"isBodyEmpty":true,"children":[{"_id":"656f977d15c495007763f6b6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"End of Speech Detection While Live Streaming","icon":"","type":"basic","slug":"understanding-end-of-speech-detection","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"understanding-end-of-speech-detection-while-streaming","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-05T21:34:53.594Z","isBodyEmpty":false,"children":[]},{"_id":"6622e3faa5e4600012945301","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Interim Results","icon":"","type":"basic","slug":"using-interim-results","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2024-04-19T21:36:58.617Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6441947c01702c0b89e46df8","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Endpointing & Interim Results With Live Streaming","icon":"","type":"basic","slug":"understand-endpointing-interim-results","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-20T19:37:32.854Z","isBodyEmpty":false,"children":[]},{"_id":"64405154b13b26021c7cefa6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Determining Your Audio Format for Live Streaming Audio","icon":"","type":"basic","slug":"determining-your-audio-format-for-live-streaming-audio","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T20:38:44.515Z","isBodyEmpty":false,"children":[]},{"_id":"64405f93dfecfb0064f3b7c2","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Measuring Streaming Latency","icon":"","type":"basic","slug":"measuring-streaming-latency","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T21:39:31.248Z","isBodyEmpty":false,"children":[]},{"_id":"644196c8050d9d16345ccc7d","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"WebSocket DATA & NET Errors When Live Streaming","icon":"","type":"basic","slug":"troubleshooting-websocket-data-and-net-errors-when-live-streaming-audio","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-20T19:47:20.836Z","isBodyEmpty":false,"children":[]},{"_id":"64419561ea58e5166c3ac938","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Recovering From Connection Errors & Timeouts When Live Streaming","icon":"","type":"basic","slug":"recovering-from-connection-errors-and-timeouts-when-live-streaming-audio","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-20T19:41:21.560Z","isBodyEmpty":false,"children":[]},{"_id":"65c6a1dc6e7a9e001ec83b21","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using Lower-Level Websockets with the Streaming API","icon":"","type":"basic","slug":"lower-level-websockets","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reference-implementation","parentDoc":"6584a356a38e25004c2cdf43","category":"65835c6c837d30002a8f700a","createdAt":"2024-02-09T22:06:20.323Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"6584a7778416430035c3ccd3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Models and Languages","icon":"","type":"basic","slug":"model-selection","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T21:00:39.655Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"647f704e77c194000c0dcba2","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Models & Languages Overview","icon":"","type":"basic","slug":"models-languages-overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"models-overview","category":"65835c6c837d30002a8f700a","createdAt":"2023-06-06T17:43:42.700Z","parentDoc":"6584a7778416430035c3ccd3","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643db0bc2ec4b0000b965918","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Languages Support","icon":"","type":"basic","slug":"language","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7778416430035c3ccd3","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-17T20:49:00.918Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64400a5c307ef411426b7ff3","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Language Detection","icon":"","type":"basic","slug":"language-detection","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7778416430035c3ccd3","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T15:35:56.347Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66748664091f0100329e4b82","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Multilingual Code-Switching","icon":"","type":"basic","slug":"multilingual-code-switching","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7778416430035c3ccd3","category":"65835c6c837d30002a8f700a","createdAt":"2024-06-20T19:43:32.824Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643db0c78865ed0019bb87a5","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Model Options","icon":"","type":"basic","slug":"model","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7778416430035c3ccd3","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-17T20:49:11.098Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643db0df4fcf0f007a011030","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Version","icon":"","type":"basic","slug":"version","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7778416430035c3ccd3","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-17T20:49:35.510Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6584a7fe6256e900241f5d70","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Formatting","icon":"","type":"basic","slug":"formatting","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T21:02:54.308Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"64400a693d3f0411b5b1cc41","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Diarization","icon":"","type":"basic","slug":"diarization","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T15:36:09.342Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6650ddb8c863d8001208b68b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Dictation","icon":"","type":"basic","slug":"dictation","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2024-05-24T18:34:32.773Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64b85952fa172a001868433f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Filler Words","icon":"","type":"basic","slug":"filler-words","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-07-19T21:44:50.271Z","parentDoc":"6584a7fe6256e900241f5d70","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6650d8b5a3b8b500192bd0fc","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Measurements","icon":"","type":"basic","slug":"measurements","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2024-05-24T18:13:09.884Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efbf9434dc300670238b4","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Numerals","icon":"","type":"basic","slug":"numerals","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:22:17.690Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643eac5a6480ec000a903641","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Paragraphs","icon":"","type":"basic","slug":"paragraphs","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:42:34.085Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efc0c97437b000b247a5e","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Profanity Filtering","icon":"","type":"basic","slug":"profanity-filter","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:22:36.666Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efd18021f8e0012e4d7d4","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Punctuation","icon":"","type":"basic","slug":"punctuation","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:27:04.938Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efc1b03e263000bf18db0","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Redaction","icon":"","type":"basic","slug":"redaction","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:22:51.834Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efd428aecfe0050343139","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Smart Formatting","icon":"","type":"basic","slug":"smart-format","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:27:46.384Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6502cc8922338f00748a115c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Supported Entity Types","icon":"","type":"basic","slug":"supported-entity-types","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-09-14T09:04:09.104Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efd25c5dad3001e6a7b8b","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Utterances","icon":"","type":"basic","slug":"utterances","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:27:17.310Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643efd342b6f1d000a93678a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Utterance Split","icon":"","type":"basic","slug":"utterance-split","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a7fe6256e900241f5d70","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:27:32.871Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6584a8d7585c05002a50bfe5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Vocabulary","icon":"","type":"basic","slug":"custom-vocabulary","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T21:06:31.023Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643efc33ea95f8005e602819","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Find and Replace","icon":"","type":"basic","slug":"find-and-replace","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a8d7585c05002a50bfe5","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T20:23:15.519Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64400a4acf6deb1a9c82ce82","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Keywords","icon":"","type":"basic","slug":"keywords","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a8d7585c05002a50bfe5","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T15:35:38.788Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64400a3e10625c194787f79f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Search","icon":"","type":"basic","slug":"search","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a8d7585c05002a50bfe5","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-19T15:35:26.596Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6584a944db51380065c8e0d4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Media Input Settings","icon":"","type":"basic","slug":"media-input-settings","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T21:08:20.097Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[{"_id":"643ea07aaa25ab004b423d90","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Channels","icon":"","type":"basic","slug":"channels","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a944db51380065c8e0d4","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T13:51:54.928Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ea0cb92a9ab06ecd6156f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Encoding","icon":"","type":"basic","slug":"encoding","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a944db51380065c8e0d4","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T13:53:15.689Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ea1ca26c0e8000bd433a8","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Multichannel","icon":"","type":"basic","slug":"multichannel","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a944db51380065c8e0d4","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T13:57:30.498Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ea29afeb82b00263027f5","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Sample Rate","icon":"","type":"basic","slug":"sample-rate","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a944db51380065c8e0d4","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:00:58.250Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6584a96b171ed00046f28814","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Results Processing","icon":"","type":"basic","slug":"results-processing","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-21T21:08:59.466Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643ea302b8182508a09fe2dd","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"STT Callback","icon":"","type":"basic","slug":"callback","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a96b171ed00046f28814","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:02:42.569Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ea7bbbee410066e557549","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Tagging","icon":"","type":"basic","slug":"tagging","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6584a96b171ed00046f28814","category":"65835c6c837d30002a8f700a","createdAt":"2023-04-18T14:22:51.839Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"657a24e7af2d7c00549c258c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Extra Metadata","icon":"","type":"basic","slug":"extra-metadata","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65835c6c837d30002a8f700a","createdAt":"2023-12-13T21:40:55.107Z","parentDoc":"6584a96b171ed00046f28814","mdx":{},"isBodyEmpty":false,"children":[]}]}]},{"_id":"6583679878340f005b381b7a","title":"TEXT TO SPEECH","slug":"text-to-speech","order":2,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-12-20T22:15:52.128Z","__v":0,"pages":[{"_id":"6669ce8d3e06bf0018f315f8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text-to-Speech REST","icon":"","type":"basic","slug":"tts-rest","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"async","category":"6583679878340f005b381b7a","createdAt":"2024-06-12T16:36:29.396Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[{"_id":"65d8d56f045351004d26cabc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Getting Started","icon":"","type":"basic","slug":"text-to-speech","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6583679878340f005b381b7a","createdAt":"2024-02-23T17:27:11.209Z","parentDoc":"6669ce8d3e06bf0018f315f8","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65838c4e92293b001cfd7936","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Feature Overview","icon":"","type":"basic","slug":"tts-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"text-to-speech-feature-overview","category":"6583679878340f005b381b7a","createdAt":"2023-12-21T00:52:30.494Z","parentDoc":"6669ce8d3e06bf0018f315f8","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d68a579168d70024fbd783","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"TTS Callback","icon":"","type":"basic","slug":"tts-callback","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"callback-1","parentDoc":"6669ce8d3e06bf0018f315f8","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T23:42:15.480Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65dfa644691e38002cca410a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Audio Output Streaming","icon":"","type":"basic","slug":"streaming-the-audio-output","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6669ce8d3e06bf0018f315f8","category":"6583679878340f005b381b7a","createdAt":"2024-02-28T21:31:48.247Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6669c469129eb1006c3c32b6","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text-to-Speech Streaming","icon":"","type":"basic","slug":"tts-websocket","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"streaming-1","category":"6583679878340f005b381b7a","createdAt":"2024-06-12T15:53:13.111Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[{"_id":"6669c47f129eb1006c3c337d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Getting Started","icon":"","type":"basic","slug":"streaming-text-to-speech","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-1","parentDoc":"6669c469129eb1006c3c32b6","category":"6583679878340f005b381b7a","createdAt":"2024-06-12T15:53:35.719Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6669ca41c7ffe5004eac704f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Feature Overview","icon":"","type":"basic","slug":"tts-streaming-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-12T16:16:00.000Z","parentDoc":"6669c469129eb1006c3c32b6","category":"6583679878340f005b381b7a","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66c532432217850012fbaea0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Control Messages","icon":"","type":"basic","slug":"tts-control-messages","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"control-messages-1","parentDoc":"6669c469129eb1006c3c32b6","category":"6583679878340f005b381b7a","createdAt":"2024-08-21T00:18:11.215Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"66c5324ff22a4c0063094e65","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Flush","icon":"","type":"basic","slug":"tts-ws-flush","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"flush","parentDoc":"66c532432217850012fbaea0","category":"6583679878340f005b381b7a","createdAt":"2024-08-21T00:18:23.907Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66c62c230db739004ce84ee6","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Clear","icon":"","type":"basic","slug":"tts-ws-clear","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tts-ws-reset","parentDoc":"66c532432217850012fbaea0","category":"6583679878340f005b381b7a","createdAt":"2024-08-21T18:04:19.270Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66c62c3ce27eb8001912be54","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Close","icon":"","type":"basic","slug":"tts-ws-close","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tts-ws-close-connection","parentDoc":"66c532432217850012fbaea0","category":"6583679878340f005b381b7a","createdAt":"2024-08-21T18:04:44.284Z","mdx":{},"isBodyEmpty":false,"children":[]}]}]},{"_id":"6601ec3db88e850052c2839a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Starter Apps","icon":"","type":"basic","slug":"tts-starter-apps","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"starter-apps-copy","parentDoc":null,"category":"6583679878340f005b381b7a","createdAt":"2024-03-25T21:27:25.559Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d62683b5e89c001dd4b2dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Voice Selection","icon":"","type":"basic","slug":"tts-models","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"models","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:36:19.767Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d62815bcf7110070dc6bac","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Media Output Settings","icon":"","type":"basic","slug":"tts-media-output-settings","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"media-input-settings-1","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:43:01.411Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[{"_id":"65d6284130e56200163da1d5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Encoding","icon":"","type":"basic","slug":"tts-encoding","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"encoding-1","parentDoc":"65d62815bcf7110070dc6bac","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:43:45.908Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d62874ccc491003399e6e1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Bit Rate","icon":"","type":"basic","slug":"tts-bit-rate","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"bit-rate","parentDoc":"65d62815bcf7110070dc6bac","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:44:36.481Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d628514349a8001ca1f9b2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Container","icon":"","type":"basic","slug":"tts-container","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"container","parentDoc":"65d62815bcf7110070dc6bac","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:44:01.937Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65d628639875ae0069b645ef","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Sample Rate","icon":"","type":"basic","slug":"tts-sample-rate","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sample-rate-1","parentDoc":"65d62815bcf7110070dc6bac","category":"6583679878340f005b381b7a","createdAt":"2024-02-21T16:44:19.639Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"65dfa5eb00821e003375e561","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Tips and Tricks","icon":"","type":"basic","slug":"tts-tips-and-tricks","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tips-and-trick","category":"6583679878340f005b381b7a","createdAt":"2024-02-28T21:30:19.163Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"66a80446fb095a0031f9eaae","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Handling Audio Issues in Text To Speech","icon":"","type":"basic","slug":"handling-audio-issues-in-text-to-speech","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-07-29T21:06:14.379Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"667c9a0982686b000f63a5c7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Sending LLM Outputs to a WebSocket","icon":"","type":"basic","slug":"send-llm-outputs-to-the-tts-web-socket","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-06-26T22:45:29.138Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66b17a58859bc7003682aacd","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text Chunking for Streaming TTS Optimization","icon":"","type":"basic","slug":"text-chunking-for-tts-streaming-optimization","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"text-chunking-for-tts-optimization-copy","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-08-06T01:20:24.276Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65ea13abd912cb0063ba6a23","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text Chunking for TTS REST Optimization","icon":"","type":"basic","slug":"text-chunking-for-tts-optimization","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"draft-text-chunking-for-tts-optimization","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-03-07T19:21:15.773Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65e0b70dc467160018739e74","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Text to Speech Latency","icon":"","type":"basic","slug":"text-to-speech-latency","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"minimizing-text-to-speech-latency","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-02-29T16:55:41.952Z","isBodyEmpty":false,"children":[]},{"_id":"65eb6060457c420010ffe7e9","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text to Speech Prompting","icon":"","type":"basic","slug":"text-to-speech-prompting","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"draft-text-to-speech-prompting","parentDoc":"65dfa5eb00821e003375e561","category":"6583679878340f005b381b7a","createdAt":"2024-03-08T19:00:48.945Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"66ccdad55d5add0062424f08","title":"Voice Agent","slug":"voice-agent","order":3,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2024-08-26T19:43:17.315Z","__v":0,"pages":[{"_id":"66ccdb64e0e7d8001fca3b0e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Getting Started","icon":"","type":"basic","slug":"voice-agent","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-1","category":"66ccdad55d5add0062424f08","createdAt":"2024-08-26T19:45:40.626Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66ccdc21f8cc490067bedf6b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Feature Overview","icon":"","type":"basic","slug":"voice-agent-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"feature-overview","category":"66ccdad55d5add0062424f08","createdAt":"2024-08-26T19:48:49.510Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66f33b7d8d10d000533a7296","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Inputs: Client Messages","icon":"","type":"basic","slug":"voice-agent-inputs","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voice-agent-control-messages","createdAt":"2024-09-24T22:18:00.000Z","category":"66ccdad55d5add0062424f08","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66f33c13322cea0018fce690","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Settings Configuration","icon":"","type":"basic","slug":"voice-agent-settings-configuration","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voice-agent-setting-configuration","createdAt":"2024-09-24T22:21:00.000Z","parentDoc":"66f33b7d8d10d000533a7296","category":"66ccdad55d5add0062424f08","isBodyEmpty":false,"children":[]},{"_id":"66f3419ad706bf002ac2d61c","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Update Instructions","icon":"","type":"basic","slug":"voice-agent-update-instructions","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-09-24T22:43:00.000Z","parentDoc":"66f33b7d8d10d000533a7296","category":"66ccdad55d5add0062424f08","isBodyEmpty":false,"children":[]},{"_id":"66f3462a37c366004c537a66","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Update Speak","icon":"","type":"basic","slug":"voice-agent-update-speak","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-update-speak","createdAt":"2024-09-24T22:59:00.000Z","parentDoc":"66f33b7d8d10d000533a7296","category":"66ccdad55d5add0062424f08","isBodyEmpty":false,"children":[]},{"_id":"66f3494342103200565c6ada","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Inject Agent Message","icon":"","type":"basic","slug":"voice-agent-inject-agent-message","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-09-24T23:17:00.000Z","parentDoc":"66f33b7d8d10d000533a7296","category":"66ccdad55d5add0062424f08","isBodyEmpty":false,"children":[]},{"_id":"67210b2c3b632300256855a7","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Function Call Response","icon":"","type":"basic","slug":"voice-agent-function-call-response","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-10-29T16:15:00.000Z","parentDoc":"66f33b7d8d10d000533a7296","category":"66ccdad55d5add0062424f08","isBodyEmpty":false,"children":[]},{"_id":"66f34a6fb3313b0030a0d578","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Keep Alive","icon":"","type":"basic","slug":"agent-keep-alive","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-agent-keep-alive","category":"66ccdad55d5add0062424f08","createdAt":"2024-09-24T23:25:35.826Z","parentDoc":"66f33b7d8d10d000533a7296","isBodyEmpty":false,"children":[]}]},{"_id":"66f34ca2f7eda50063f012df","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Outputs: Server Messages","icon":"","type":"basic","slug":"voice-agent-outputs","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voice-agent-server-messages","createdAt":"2024-09-24T23:29:00.000Z","category":"66ccdad55d5add0062424f08","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6760a2362cdc6c0011ee17bc","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Welcome","icon":"","type":"basic","slug":"voice-agent-welcome-message","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"welcome","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:57:10.255Z","isBodyEmpty":false,"children":[]},{"_id":"6760a243c4d97d003622574e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Setting Applied","icon":"","type":"basic","slug":"voice-agent-setting-applied-message","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"setting-applied","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:57:23.834Z","isBodyEmpty":false,"children":[]},{"_id":"6760a259d991af0040b34df7","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Conversation Context","icon":"","type":"basic","slug":"voice-agent-conversation-context","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"conversation-context","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:57:45.745Z","isBodyEmpty":false,"children":[]},{"_id":"6760a267cb707f002f0baf5d","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Conversation Text","icon":"","type":"basic","slug":"voice-agent-conversation-text","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"conversation-text","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:57:59.772Z","isBodyEmpty":false,"children":[]},{"_id":"6760a272b6bb340010b4b85d","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"User Started Speaking","icon":"","type":"basic","slug":"voice-agent-user-started-speaking","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"user-started-speaking","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:58:10.477Z","isBodyEmpty":false,"children":[]},{"_id":"6760a27f48a22d0030fae7af","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Thinking","icon":"","type":"basic","slug":"voice-agent-agent-thinking","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"agent-thinking","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:58:23.232Z","isBodyEmpty":false,"children":[]},{"_id":"6760a288c40841005c32eb99","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Function Call Request","icon":"","type":"basic","slug":"voice-agent-function-call-request","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"function-call-request","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:58:32.557Z","isBodyEmpty":false,"children":[]},{"_id":"6760a295cb707f002f0bb132","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Function Calling Message","icon":"","type":"basic","slug":"voice-agent-function-calling-message","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voice-agent-function-calling","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:58:45.924Z","isBodyEmpty":false,"children":[]},{"_id":"6760a2a25d3882004bd41294","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Started Speaking","icon":"","type":"basic","slug":"voice-agent-agent-started-speaking","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"agent-started-speaking","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:58:58.837Z","isBodyEmpty":false,"children":[]},{"_id":"6760a2b1e084dd00101691cd","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Audio Done","icon":"","type":"basic","slug":"voice-agent-agent-audio-done","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"agent-audio-done","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:59:13.809Z","isBodyEmpty":false,"children":[]},{"_id":"6760a2b81717bb0075403d4e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Server Errors","icon":"","type":"basic","slug":"voice-agent-server-errors","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"errors-1","parentDoc":"66f34ca2f7eda50063f012df","category":"66ccdad55d5add0062424f08","createdAt":"2024-12-16T21:59:20.900Z","isBodyEmpty":false,"children":[]}]},{"_id":"66f44f2ee003eb001e2f5f67","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent LLM Models","icon":"","type":"basic","slug":"voice-agent-llm-models","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-llm-models","category":"66ccdad55d5add0062424f08","createdAt":"2024-09-25T17:58:06.994Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66f4577cf1cd23004bbdf74b","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Agent Media Inputs & Outputs","icon":"","type":"basic","slug":"voice-agent-media-inputs-outputs","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-agent-media-inputs-outputs","category":"66ccdad55d5add0062424f08","createdAt":"2024-09-25T18:33:32.773Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66cce613500b2a004d29e3b0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Tips & Tricks","icon":"","type":"basic","slug":"voice-agent-tips-tricks","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tips-tricks-voice-agent","category":"66ccdad55d5add0062424f08","createdAt":"2024-08-26T20:31:15.834Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"66cce624b88a1c0019c0dee5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Voice Agent Audio & Playback","icon":"","type":"basic","slug":"voice-agent-audio-playback","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"voice-agent-tips-and-tricks","parentDoc":"66cce613500b2a004d29e3b0","category":"66ccdad55d5add0062424f08","createdAt":"2024-08-26T20:31:32.279Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6705a7a178d2180011874b09","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Function Calling with Voice Agents","icon":"","type":"basic","slug":"voice-agents-function-calling","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-function-calling-with-voice-agents","parentDoc":"66cce613500b2a004d29e3b0","category":"66ccdad55d5add0062424f08","createdAt":"2024-10-08T21:44:01.007Z","isBodyEmpty":false,"children":[]},{"_id":"6740d8750288de0011ff968d","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Voice Agent Adaptive Echo Cancellation","icon":"","type":"basic","slug":"voice-agent-echo-cancellation","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-voice-agent-echo-cancellation","parentDoc":"66cce613500b2a004d29e3b0","category":"66ccdad55d5add0062424f08","createdAt":"2024-11-22T19:16:05.928Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65836781c0cfb00038820405","title":"Intelligence","slug":"text-to-text-intelligence","order":4,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-12-20T22:15:29.152Z","__v":0,"pages":[{"_id":"65b7ebd4e350290046d5f341","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Audio Intelligence","icon":"","type":"basic","slug":"features","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:17:56.631Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"65bbe3843b3e0b00466e03b7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Getting Started","icon":"","type":"basic","slug":"audio-intelligence","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65836781c0cfb00038820405","createdAt":"2024-02-01T18:31:32.685Z","parentDoc":"65b7ebd4e350290046d5f341","isBodyEmpty":false,"children":[]},{"_id":"658367eeabd984007ec75c3a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Feature Overview","icon":"","type":"basic","slug":"stt-intelligence-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"feature-overview","category":"65836781c0cfb00038820405","createdAt":"2023-12-20T22:17:18.985Z","parentDoc":"65b7ebd4e350290046d5f341","isBodyEmpty":false,"children":[]},{"_id":"64556dd098d2440025535514","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Entity Detection","icon":"","type":"basic","slug":"detect-entities","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ebd4e350290046d5f341","category":"65836781c0cfb00038820405","createdAt":"2023-05-05T20:57:52.631Z","isBodyEmpty":false,"children":[]},{"_id":"65b7ed13db6b910053aa240b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Intent Recognition","icon":"","type":"basic","slug":"intent-recognition","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ebd4e350290046d5f341","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:23:15.891Z","isBodyEmpty":false,"children":[]},{"_id":"65b7ed598ae66e0076ce87a5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Sentiment Analysis","icon":"","type":"basic","slug":"sentiment-analysis","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ebd4e350290046d5f341","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:24:25.246Z","isBodyEmpty":false,"children":[]},{"_id":"64401469786ad61b5cfb1f2c","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Summarization","icon":"","type":"basic","slug":"summarization","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65b7ebd4e350290046d5f341","category":"65836781c0cfb00038820405","createdAt":"2023-04-19T16:18:49.169Z","isBodyEmpty":false,"children":[]},{"_id":"65c1045dd1656b005f661d12","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Topic Detection","icon":"","type":"basic","slug":"topic-detection","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"topic-detection-1","parentDoc":"65b7ebd4e350290046d5f341","category":"65836781c0cfb00038820405","createdAt":"2024-02-05T15:53:01.083Z","isBodyEmpty":false,"children":[]}]},{"_id":"666787b8408ff8003711ed75","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text Intelligence","icon":"","type":"basic","slug":"text-intelligence-1","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65836781c0cfb00038820405","createdAt":"2024-06-10T23:09:44.541Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"65b8190bddd1ce0039a3af51","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Getting Started","icon":"","type":"basic","slug":"text-intelligence","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T21:30:51.629Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]},{"_id":"65838c5f5da44e004686ba9d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Feature Overview","icon":"","type":"basic","slug":"text-intelligence-feature-overview","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tts-feature-overview","category":"65836781c0cfb00038820405","createdAt":"2023-12-21T00:52:47.664Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]},{"_id":"65b7edf531b5e10046e6a81e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Intent Recognition","icon":"","type":"basic","slug":"text-intention-recognition","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"intention-recognition","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:27:01.268Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]},{"_id":"65b7ee0f7af0fc000fe621f7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Sentiment Analysis","icon":"","type":"basic","slug":"text-sentiment-analysis","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sentiment-analysis-1","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:27:27.858Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]},{"_id":"65b7ede466636600711ff3c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Summarization","icon":"","type":"basic","slug":"text-summarization","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"summarization-1","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:26:44.795Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]},{"_id":"65b7ee01754b99000fb5597e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Topic Detection","icon":"","type":"basic","slug":"text-topic-detection","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"topic-detection-1","category":"65836781c0cfb00038820405","createdAt":"2024-01-29T18:27:13.111Z","parentDoc":"666787b8408ff8003711ed75","isBodyEmpty":false,"children":[]}]}]},{"_id":"643d83b0019f6f0035cab192","title":"Guides","slug":"guides","order":5,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-17T17:36:48.137Z","__v":0,"pages":[{"_id":"643da1c53dace0000ddd1546","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Fundamentals","icon":"","type":"basic","slug":"fundamentals","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:45:09.957Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"65b973dcf3a3a100541f93ca","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Make Your First API Request","icon":"","type":"basic","slug":"make-your-first-api-request","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"before-making-your-first-api-request-copy","category":"643d83b0019f6f0035cab192","createdAt":"2024-01-30T22:10:36.449Z","parentDoc":"643da1c53dace0000ddd1546","isBodyEmpty":false,"children":[]},{"_id":"643da1d2ab2d6f0070682b35","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Authenticating","icon":"","type":"basic","slug":"authenticating","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:45:22.967Z","isBodyEmpty":false,"children":[]},{"_id":"66a18f4ea07fcc0011a4c867","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Model Metadata","icon":"","type":"basic","slug":"model-metadata","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-models","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2024-07-24T23:33:34.860Z","isBodyEmpty":false,"children":[]},{"_id":"643da1df044054000b4b0441","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Managing Projects","icon":"","type":"basic","slug":"managing-projects","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:45:35.577Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643da1f1da0e7800564d16ce","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Using Multiple Projects","icon":"","type":"basic","slug":"using-multiple-projects","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:45:53.109Z","isBodyEmpty":false,"children":[]},{"_id":"643da2013be15a002da2a50d","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Working With Roles & API Scopes","icon":"","type":"basic","slug":"working-with-roles","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:46:09.591Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643da20f7c2c61000b24ce1a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Supported Audio Formats","icon":"","type":"basic","slug":"supported-audio-formats","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:46:23.584Z","isBodyEmpty":false,"children":[]},{"_id":"643da295a4e885006c5e62eb","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Deployment Options","icon":"","type":"basic","slug":"deployment-options","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-17T19:48:37.688Z","isBodyEmpty":false,"children":[]},{"_id":"646e4babdf0e7700115d3f66","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Creating API Keys","icon":"","type":"basic","slug":"create-additional-api-keys","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-the-deepgram-console","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-24T17:38:51.207Z","isBodyEmpty":false,"children":[]},{"_id":"668ecd77b01214002ace48e5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using the Sec-WebSocket-Protocol","icon":"","type":"basic","slug":"using-the-sec-websocket-protocol","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-the-sec-websocket-protocol-with-deepgram-apis","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2024-07-10T18:05:43.561Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"651f2c8b906ded0061ae80ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Logs & Usage Data","icon":"","type":"basic","slug":"using-logs-usage","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"understanding-logs-usage","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2023-10-05T21:37:15.707Z","isBodyEmpty":false,"children":[]},{"_id":"667c3a9db0760300182892e8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Deepgram Model Improvement Partnership Program","icon":"","type":"basic","slug":"the-deepgram-model-improvement-partnership-program","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2024-06-26T15:58:21.429Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"668eed99725bc3001c7ea3c2","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Working With Concurrency Rate Limits","icon":"","type":"basic","slug":"working-with-concurrency-rate-limits","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2024-07-10T20:22:49.366Z","isBodyEmpty":false,"children":[]},{"_id":"665df2ce76efd300707e8a6b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"API Rate Limits","icon":"","type":"link","slug":"api-rate-limits-1","order":13,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://developers.deepgram.com/reference/api-rate-limits","link_external":true,"previousSlug":"","parentDoc":"643da1c53dace0000ddd1546","category":"643d83b0019f6f0035cab192","createdAt":"2024-06-03T16:43:58.825Z","isBodyEmpty":true,"children":[]}]},{"_id":"64405fe3d15b320012cd02d8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Migrating","icon":"","type":"basic","slug":"migrating","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-19T21:40:51.476Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"64406583232093004bbdb021","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Migrating From Amazon Web Services (AWS) Transcribe to Deepgram","icon":"","type":"basic","slug":"migrating-from-amazon-web-services-aws-transcribe-to-deepgram","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64405fe3d15b320012cd02d8","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-19T22:04:51.444Z","isBodyEmpty":false,"children":[]},{"_id":"644067dc109fc700335bf5b7","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Migrating From Google Speech-to-Text (STT) to Deepgram","icon":"","type":"basic","slug":"migrating-from-google-speech-to-text-stt-to-deepgram","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64405fe3d15b320012cd02d8","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-19T22:14:52.474Z","isBodyEmpty":false,"children":[]},{"_id":"654c26f2668ddb000b8d3900","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Migrating From OpenAI Whisper to Deepgram","icon":"","type":"basic","slug":"migrating-from-openai-whisper-to-deepgram","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"migrating-from-openai-to-deepgram","parentDoc":"64405fe3d15b320012cd02d8","category":"643d83b0019f6f0035cab192","createdAt":"2023-11-09T00:25:22.102Z","isBodyEmpty":false,"children":[]},{"_id":"665105c0a623e0000f191ad5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Migrating from AssemblyAI Speech-to-Text to Deepgram","icon":"","type":"basic","slug":"migrating-from-assembly-ai-speech-to-text-to-deepgram","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"migrating-from-assembly-ai-speech-to-text-to-deepgram-js-sdk","parentDoc":"64405fe3d15b320012cd02d8","category":"643d83b0019f6f0035cab192","createdAt":"2024-05-24T21:25:20.898Z","isBodyEmpty":false,"children":[]}]},{"_id":"645bf253639f1c00579c1098","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Use Case Examples","icon":"","type":"basic","slug":"use-cases","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-10T19:36:51.086Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6696c94275ed72003e9815e0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Build a Voice Agent with Twilio & OpenAI & Deepgram","icon":"","type":"basic","slug":"build-voice-agent-with-twilio-deepgram-openai","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-twilio-with-deepgram-speech-to-text-and-text-to-speech","parentDoc":"645bf253639f1c00579c1098","category":"643d83b0019f6f0035cab192","createdAt":"2024-07-16T19:25:54.449Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"644fa0b35cd254005aa35cd3","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Calculate Talk Time Analytics","icon":"","type":"basic","slug":"calculate-talk-time-analytics","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-01T11:21:23.473Z","parentDoc":"645bf253639f1c00579c1098","isBodyEmpty":false,"children":[]},{"_id":"644fa14653d17a007a65dccb","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Transcribe Meetings in Realtime","icon":"","type":"basic","slug":"transcribe-meetings-in-realtime","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-01T11:23:50.238Z","parentDoc":"645bf253639f1c00579c1098","isBodyEmpty":false,"children":[]},{"_id":"644fa1b1cd5d1101febb14d2","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Transcribe Recorded Calls With Twilio","icon":"","type":"basic","slug":"transcribe-recorded-calls-with-twilio","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-01T11:25:37.373Z","parentDoc":"645bf253639f1c00579c1098","isBodyEmpty":false,"children":[]}]},{"_id":"645bf4d11e64cb001ee7d2a8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Integrations","icon":"","type":"basic","slug":"integrations","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-05-10T19:47:29.460Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"65453dd1606e2d0043d4cbd7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Amazon Connect and Deepgram","icon":"","type":"basic","slug":"deepgram-with-amazon-connect","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"docs-title","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-11-03T18:37:05.965Z","isBodyEmpty":false,"children":[]},{"_id":"6491e6284260532050171358","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"AWS S3 Presigned URLs and Deepgram","icon":"","type":"basic","slug":"using-aws-s3-presigned-urls-with-the-deepgram-api","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-06-20T17:47:20.858Z","isBodyEmpty":false,"children":[]},{"_id":"64a83cd34250080c713e77df","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Genesys and Deepgram","icon":"","type":"basic","slug":"genesys-with-deepgram","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-07-07T16:26:59.851Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"657c6a13d6ee5600692f068e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Dialogflow CX and Deepgram","icon":"","type":"basic","slug":"use-deepgram-with-dialogflow-cx","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-12-15T15:00:35.205Z","isBodyEmpty":false,"children":[]},{"_id":"6580d1d1ddd2d6004e1426ed","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Make.com and Deepgram","icon":"","type":"basic","slug":"makecom-deepgram-integration","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-12-18T23:12:17.066Z","isBodyEmpty":false,"children":[]},{"_id":"64411a22989813002832d0c7","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Twilio and Deepgram STT","icon":"","type":"basic","slug":"on-premise-twilio-integration","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-20T10:55:30.583Z","parentDoc":"645bf4d11e64cb001ee7d2a8","isBodyEmpty":false,"children":[]},{"_id":"6646858f83b8ec00599708db","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Twilio and Deepgram TTS","icon":"","type":"basic","slug":"twilio-and-deepgram-tts","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2024-05-16T22:15:43.792Z","isBodyEmpty":false,"children":[]},{"_id":"658dc298102adf000f3ff7ce","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Zapier and Deepgram","icon":"","type":"basic","slug":"zapier-integration","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"645bf4d11e64cb001ee7d2a8","category":"643d83b0019f6f0035cab192","createdAt":"2023-12-28T18:46:48.141Z","isBodyEmpty":false,"children":[]},{"_id":"64411843d6e39407d6f63dbc","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Zoom and Deepgram","icon":"","type":"basic","slug":"integrate-deepgram-with-zoom","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b0019f6f0035cab192","createdAt":"2023-04-20T10:47:31.761Z","parentDoc":"645bf4d11e64cb001ee7d2a8","isBodyEmpty":false,"children":[]}]}]},{"_id":"643ec443808a90000a80dd5a","title":"SDKS","slug":"sdks","order":6,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-18T16:24:35.626Z","__v":0,"pages":[{"_id":"64554a21b7231115271c4039","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Deepgram SDKs","icon":"","type":"basic","slug":"deepgram-sdks","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643ec443808a90000a80dd5a","createdAt":"2023-05-05T18:25:37.258Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64b855e8f2402f0051d829cb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"SDK Feature Matrix","icon":"","type":"basic","slug":"sdk-feature-matrix","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sdk-feature-parity-matrix","category":"643ec443808a90000a80dd5a","createdAt":"2023-07-19T21:30:16.233Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66845a23f89eae00187c9ea4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Custom Add On Parameters with SDKs","icon":"","type":"basic","slug":"using-custom-parameters-sdks","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-custom-parameters-js-sdk","parentDoc":null,"category":"643ec443808a90000a80dd5a","createdAt":"2024-07-02T19:50:59.347Z","isBodyEmpty":false,"children":[]},{"_id":"66848feea58822000fcc570d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Custom Headers with SDKs","icon":"","type":"basic","slug":"using-custom-headers-and-sdks","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-using-custom-headers-and-sdks","category":"643ec443808a90000a80dd5a","createdAt":"2024-07-02T23:40:30.564Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66849867f89eae00187cfc87","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Client Options with SDKs","icon":"","type":"basic","slug":"using-client-options-with-sdks","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wip-using-client-options-with-sdks","category":"643ec443808a90000a80dd5a","createdAt":"2024-07-03T00:16:39.542Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"644004f04f55c7001f918227","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"JavaScript SDK","icon":"","type":"basic","slug":"js-sdk","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-sdk","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-19T15:12:48.447Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"652e6ab9e2940a006cd877fc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"JavaScript SDK V2 to V3 Migration Guide","icon":"","type":"basic","slug":"js-sdk-v2-to-v3-migration-guide","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-sdk-v2-to-v3-migration-guide","parentDoc":"644004f04f55c7001f918227","category":"643ec443808a90000a80dd5a","createdAt":"2023-10-17T11:06:33.728Z","isBodyEmpty":false,"children":[]},{"_id":"6440fd69af15a503433e85f4","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Pre-Recorded Audio Transcription","icon":"","type":"basic","slug":"node-sdk-pre-recorded-transcription","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pre-recorded-transcription","parentDoc":"644004f04f55c7001f918227","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T08:52:57.534Z","isBodyEmpty":false,"children":[]},{"_id":"6440feafd26106005e5c99d0","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Live Streaming Audio Transcription","icon":"","type":"basic","slug":"node-sdk-streaming-transcription","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"streaming-transcription","parentDoc":"644004f04f55c7001f918227","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T08:58:23.688Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6657b0708e81660058885afa","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text to Speech REST","icon":"","type":"basic","slug":"js-sdk-text-to-speech","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"js-sdk-text-to-speecy","parentDoc":"644004f04f55c7001f918227","category":"643ec443808a90000a80dd5a","createdAt":"2024-05-29T22:47:12.978Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66fc12e10c49cb000f02c501","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text to Speech Streaming","icon":"","type":"basic","slug":"js-sdk-streaming-text-to-speech","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"js-sdk-live-text-to-speech","parentDoc":"644004f04f55c7001f918227","category":"643ec443808a90000a80dd5a","createdAt":"2024-10-01T15:18:57.217Z","isBodyEmpty":false,"children":[]}]},{"_id":"644109819c821c00507cb33f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Python SDK","icon":"","type":"basic","slug":"python-sdk","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T09:44:33.375Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"658b169105ba650069013c59","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Python SDK V2 to V3 Migration Guide","icon":"","type":"basic","slug":"python-sdk-v2-to-v3-migration-guide","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"javascript-sdk-v2-to-v3-migration-guide-copy","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2023-12-26T18:08:17.854Z","isBodyEmpty":false,"children":[]},{"_id":"6667a0aeeeed09006373c860","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Threaded and Async IO Task Support","icon":"","type":"basic","slug":"threaded-and-async-io-task-support","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2024-06-11T00:56:14.690Z","isBodyEmpty":false,"children":[]},{"_id":"64410c969a4e88084a08e9b7","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Pre-Recorded Audio Transcription","icon":"","type":"basic","slug":"python-sdk-pre-recorded-transcription","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pre-recorded-transcription-1","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T09:57:42.829Z","isBodyEmpty":false,"children":[]},{"_id":"64410f70173957000dee918f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Live Streaming Audio Transcription","icon":"","type":"basic","slug":"python-sdk-streaming-transcription","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"streaming-transcription-1","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:09:52.466Z","isBodyEmpty":false,"children":[]},{"_id":"6657bb0e1f2ad700769f30b3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text To Speech REST","icon":"","type":"basic","slug":"python-sdk-text-to-speech","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-05-29T23:31:00.000Z","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66fc1307fc53930064567bbb","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text To Speech Streaming","icon":"","type":"basic","slug":"python-sdk-streaming-text-to-speech","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"python-sdk-live-text-to-speech","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2024-10-01T15:19:35.182Z","isBodyEmpty":false,"children":[]},{"_id":"65ca7db4c50077005b36c277","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Python Notebooks","icon":"","type":"basic","slug":"python-notebooks","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644109819c821c00507cb33f","category":"643ec443808a90000a80dd5a","createdAt":"2024-02-12T20:21:08.859Z","isBodyEmpty":false,"children":[]}]},{"_id":"644110f493196f005f7df8b6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":".NET SDK","icon":"","type":"basic","slug":"dotnet-sdk","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"net-sdk","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:16:20.156Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"66142675365bcb001286fca0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":".NET SDK V3 to V4 Migration Guide","icon":"","type":"basic","slug":"dotnet-sdk-v3-to-v4-migration-guide","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"python-sdk-v2-to-v3-migration-guide-copy","parentDoc":"644110f493196f005f7df8b6","category":"643ec443808a90000a80dd5a","createdAt":"2024-04-08T17:16:37.407Z","isBodyEmpty":false,"children":[]},{"_id":"644112cd3934da003eeeb2aa","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Pre-Recorded Audio Transcription","icon":"","type":"basic","slug":"dotnet-sdk-pre-recorded-transcription","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pre-recorded-transcription-2","parentDoc":"644110f493196f005f7df8b6","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:24:13.528Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6441138bd8a1620066298bc7","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Live Streaming Audio Transcription","icon":"","type":"basic","slug":"dotnet-sdk-streaming-transcription","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"streaming-transcription-2","parentDoc":"644110f493196f005f7df8b6","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:27:23.429Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"665f1f1568fac9001817bf69","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text to Speech REST","icon":"","type":"basic","slug":"dotnet-sdk-text-to-speech","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-04T14:00:00.000Z","parentDoc":"644110f493196f005f7df8b6","category":"643ec443808a90000a80dd5a","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66fc131b1d925500447a6a9f","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text to Speech Streaming","icon":"","type":"basic","slug":"dotnet-sdk-streaming-text-to-speech","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"dotnet-sdk-live-text-to-speech","parentDoc":"644110f493196f005f7df8b6","category":"643ec443808a90000a80dd5a","createdAt":"2024-10-01T15:19:55.952Z","isBodyEmpty":false,"children":[]}]},{"_id":"64411535bd117e0055d9c361","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Go SDK","icon":"","type":"basic","slug":"go-sdk","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://pkg.go.dev/github.com/deepgram-devs/deepgram-go-sdk","link_external":true,"previousSlug":"","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:34:29.220Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"668ec74accabea00658290be","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Go SDK v1.2 to v1.3 Interface Change","icon":"","type":"basic","slug":"go-sdk-v12-to-v136-migration-guide","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"net-sdk-v3-to-v4-migration-guide-copy","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","createdAt":"2024-07-10T17:39:22.389Z","isBodyEmpty":false,"children":[]},{"_id":"6554e010a52989001e85fdfc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pre-Recorded Audio Transcription","icon":"","type":"basic","slug":"pre-recorded-audio-transcription","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","createdAt":"2023-11-15T15:13:20.520Z","isBodyEmpty":false,"children":[]},{"_id":"6555729bb81d610028166df2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Live Streaming Audio Transcription","icon":"","type":"basic","slug":"live-streaming-audio-transcription","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","createdAt":"2023-11-16T01:38:35.551Z","isBodyEmpty":false,"children":[]},{"_id":"665f197803383200577c8997","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text-to-Speech REST","icon":"","type":"basic","slug":"go-sdk-text-to-speech","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2024-06-04T13:40:00.000Z","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66fc137131ea8866b242aefa","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Text-to-Speech Streaming","icon":"","type":"basic","slug":"go-sdk-streaming-text-to-speech","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"go-sdk-live-text-to-speech","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","createdAt":"2024-10-01T15:21:21.848Z","isBodyEmpty":false,"children":[]},{"_id":"66425eae792b6400616825fb","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Go SDK Docs","icon":"","type":"link","slug":"go-sdk-docs","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://pkg.go.dev/github.com/deepgram/deepgram-go-sdk@main","link_external":true,"previousSlug":"","parentDoc":"64411535bd117e0055d9c361","category":"643ec443808a90000a80dd5a","createdAt":"2024-05-13T18:40:46.535Z","isBodyEmpty":true,"children":[]}]},{"_id":"644115725bf6e4066c1c0f56","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Rust SDK [community]","icon":"","type":"link","slug":"rust-sdk-community","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://github.com/deepgram/deepgram-rust-sdk","link_external":true,"previousSlug":"","category":"643ec443808a90000a80dd5a","createdAt":"2023-04-20T10:35:30.229Z","parentDoc":null,"isBodyEmpty":true,"children":[]},{"_id":"660db073f0382f0011ba1b6c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Flutter SDK [community]","icon":"","type":"link","slug":"flutter-sdk-community","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://pub.dev/packages/deepgram_speech_to_text","link_external":true,"previousSlug":"","category":"643ec443808a90000a80dd5a","createdAt":"2024-04-03T19:39:31.141Z","parentDoc":null,"isBodyEmpty":true,"children":[]}]},{"_id":"64412e928a7a28055a7d600e","title":"Self-Hosted Deployments","slug":"on-premises-deployments","order":7,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-20T12:22:42.434Z","__v":0,"pages":[{"_id":"64412f04177b6a001829fb40","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Introduction","icon":"","type":"basic","slug":"self-hosted-introduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"on-prem-introduction","parentDoc":null,"category":"64412e928a7a28055a7d600e","createdAt":"2023-04-20T12:24:36.171Z","isBodyEmpty":false,"children":[]},{"_id":"644970e1753d0601037c15a5","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Deployment Environments","icon":"","type":"basic","slug":"self-hosted-deployment-environments","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"on-prem-deployment-environments","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-26T18:43:45.300Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"664769cd8dff60001708bf2b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Docker/Podman","icon":"","type":"basic","slug":"dockerpodman","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-17T14:29:33.937Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6648f069726156001046ab43","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Platform Options","icon":"","type":"basic","slug":"docker-podman-infrastructure-options","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"infrastructure-options","parentDoc":"664769cd8dff60001708bf2b","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-18T18:16:09.882Z","isBodyEmpty":true,"children":[{"_id":"6449712c4631a500e605997b","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Amazon Web Services","icon":"","type":"basic","slug":"aws-docker-podman","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"aws","parentDoc":"6648f069726156001046ab43","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-26T18:45:00.055Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"644bd20339a55d001903e544","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Google Cloud Platform","icon":"","type":"basic","slug":"gcp-docker-podman","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"gcp","parentDoc":"6648f069726156001046ab43","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-28T14:02:43.852Z","isBodyEmpty":false,"children":[]},{"_id":"662906e2632967002c3bcd42","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Oracle Cloud Infrastructure","icon":"","type":"basic","slug":"oci-docker-podman","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"oci","parentDoc":"6648f069726156001046ab43","category":"64412e928a7a28055a7d600e","createdAt":"2024-04-24T13:19:30.214Z","isBodyEmpty":false,"children":[]},{"_id":"644bd262708f4b003c4750a0","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Microsoft Azure","icon":"","type":"basic","slug":"azure-docker-podman","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"azure","parentDoc":"6648f069726156001046ab43","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-28T14:04:18.662Z","isBodyEmpty":false,"children":[]},{"_id":"644bd2abd1a1610df1c038ff","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Bare-Metal Servers","icon":"","type":"basic","slug":"bare-metal","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6648f069726156001046ab43","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-28T14:05:31.802Z","isBodyEmpty":false,"children":[]}]},{"_id":"64b865f923df9700488807ca","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Drivers and Container Orchestration Tools","icon":"","type":"basic","slug":"drivers-and-containerization-platforms","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"664769cd8dff60001708bf2b","category":"64412e928a7a28055a7d600e","createdAt":"2023-07-19T22:38:49.426Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64bc55f2b9814c000ac831aa","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Deploy Deepgram Services","icon":"","type":"basic","slug":"deploy-deepgram-services","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deploy-deepgram-services-1","category":"64412e928a7a28055a7d600e","createdAt":"2023-07-22T22:19:30.463Z","parentDoc":"664769cd8dff60001708bf2b","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"649c669ebf00340bdee8abc6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Kubernetes","icon":"","type":"basic","slug":"kubernetes","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"64412e928a7a28055a7d600e","createdAt":"2023-06-28T16:58:06.079Z","isBodyEmpty":false,"children":[{"_id":"6648f2255f42a0002fd017ea","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Platform Options","icon":"","type":"basic","slug":"infrastructure-options","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"649c669ebf00340bdee8abc6","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-18T18:23:33.373Z","isBodyEmpty":true,"children":[{"_id":"6648f23ebc532e006ad3eb18","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Amazon Web Services","icon":"","type":"basic","slug":"aws-k8s","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"amazon-web-services","parentDoc":"6648f2255f42a0002fd017ea","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-18T18:23:58.001Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66593c4234f9220065bfc1c5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Google Cloud Platform","icon":"","type":"basic","slug":"gcp-k8s","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"google-cloud-platform","parentDoc":"6648f2255f42a0002fd017ea","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-31T02:56:02.609Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6648f1ff5546fe00632d6bbf","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Self-Managed Kubernetes","icon":"","type":"basic","slug":"self-managed-kubernetes","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"kubernetes-bare-metal","parentDoc":"6648f2255f42a0002fd017ea","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-18T18:22:55.381Z","isBodyEmpty":false,"children":[]}]},{"_id":"6659446af4607200550ac777","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Securing Your Cluster","icon":"","type":"basic","slug":"securing-your-cluster","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"649c669ebf00340bdee8abc6","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-31T03:30:50.678Z","isBodyEmpty":false,"children":[]}]},{"_id":"64ac2302a9cd72006ec87566","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Self Service Licensing & Credentials","icon":"","type":"basic","slug":"self-hosted-self-service-tutorial","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"on-prem-self-service-tutorial","parentDoc":null,"category":"64412e928a7a28055a7d600e","createdAt":"2023-07-10T15:25:54.906Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64413afb938335000a02b22f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Scaling and Deployment Strategies","icon":"","type":"basic","slug":"scaling-and-deployment-strategies","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deployments","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-20T13:15:39.345Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6449722a663b7502b91c5e6f","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"System Maintenance","icon":"","type":"basic","slug":"maintaining","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64413afb938335000a02b22f","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-26T18:49:14.046Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"647a3e918c4277000e65d711","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Auto-Scaling","icon":"","type":"basic","slug":"autoscaling-best-practices","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"autoscaling-best-practices-1","parentDoc":"64413afb938335000a02b22f","category":"64412e928a7a28055a7d600e","createdAt":"2023-06-02T19:10:09.809Z","isBodyEmpty":false,"children":[]},{"_id":"644a8a10a733940026f13454","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Metrics Guide","icon":"","type":"basic","slug":"metrics-guide","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64413afb938335000a02b22f","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-27T14:43:28.830Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6679d85bcca1fe006ac9df2d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Ingress Authentication","icon":"","type":"basic","slug":"self-hosted-ingress-auth","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64413afb938335000a02b22f","category":"64412e928a7a28055a7d600e","createdAt":"2024-06-24T20:34:35.518Z","isBodyEmpty":false,"children":[]},{"_id":"66980cb56e4f3600539fb54b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Using Private Container Registries","icon":"","type":"basic","slug":"using-private-container-registries","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64413afb938335000a02b22f","category":"64412e928a7a28055a7d600e","createdAt":"2024-07-17T18:25:57.154Z","isBodyEmpty":false,"children":[]}]},{"_id":"644a89d06af3750011c0720d","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Self-Hosted Add Ons","icon":"","type":"basic","slug":"self-hosted-add-ons","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"on-prem-add-ons","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-27T14:42:24.116Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"644a8a04c8af4006d5568bf6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"License Proxy","icon":"","type":"basic","slug":"license-proxy","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a89d06af3750011c0720d","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-27T14:43:16.847Z","isBodyEmpty":false,"children":[]},{"_id":"664e2af2b4637e0023c94a8d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Self-Hosted Text to Speech","icon":"","type":"basic","slug":"self-hosted-text-to-speech","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a89d06af3750011c0720d","category":"64412e928a7a28055a7d600e","createdAt":"2024-05-22T17:27:14.510Z","isBodyEmpty":false,"children":[]},{"_id":"644a8a200056c908be67adc5","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Prometheus Integration","icon":"","type":"basic","slug":"prometheus-integration","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a89d06af3750011c0720d","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-27T14:43:44.368Z","isBodyEmpty":false,"children":[]},{"_id":"644a8a4e0e3d75000aa5debe","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Deepgram UniMRCP Plugin","icon":"","type":"basic","slug":"deepgram-unimrcp-plugin","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a89d06af3750011c0720d","category":"64412e928a7a28055a7d600e","createdAt":"2023-04-27T14:44:30.602Z","isBodyEmpty":false,"children":[]}]},{"_id":"65cf98e20105630039a44796","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using SDKs with Self-Hosted","icon":"","type":"basic","slug":"using-sdks-with-self-hosted","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-sdks-via-on-prem","category":"64412e928a7a28055a7d600e","createdAt":"2024-02-16T17:18:26.864Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"643d83b7379fb80d4fcff8f2","title":"Security","slug":"security","order":8,"reference":false,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-17T17:36:55.808Z","__v":0,"pages":[{"_id":"64414d8f2013b1000b1a14e1","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Security Policy","icon":"","type":"basic","slug":"security-policy","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b7379fb80d4fcff8f2","createdAt":"2023-04-20T14:34:55.864Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64414da6555d640393b3faad","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Data Privacy Compliance","icon":"","type":"basic","slug":"data-privacy-compliance","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b7379fb80d4fcff8f2","createdAt":"2023-04-20T14:35:18.414Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64414dc849fab90027ccde9a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Information Security & Privacy Statement","icon":"","type":"basic","slug":"information-security-privacy-statement","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"643d83b7379fb80d4fcff8f2","createdAt":"2023-04-20T14:35:52.155Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"64249ca11af6b70060c01043","title":"GENERAL","slug":"authentication","order":1,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-03-29T20:16:33.630Z","__v":0,"pages":[{"_id":"648a314a3b8d080014552343","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Deepgram API Overview","icon":"","type":"basic","slug":"deepgram-api-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deepgram-api-survey","category":"64249ca11af6b70060c01043","createdAt":"2023-06-14T21:29:46.069Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64249ca11af6b70060c01044","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Authentication","icon":"","type":"basic","slug":"authentication","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-with-your-api-1","category":"64249ca11af6b70060c01043","createdAt":"2023-03-29T20:16:33.650Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"644e3100fa3a8800129cd14c","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Errors","icon":"","type":"basic","slug":"errors","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64249ca11af6b70060c01043","createdAt":"2023-04-30T09:12:32.511Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"65fb5aad8f963e0010e1de5f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"API Rate Limits","icon":"","type":"basic","slug":"api-rate-limits","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64249ca11af6b70060c01043","createdAt":"2024-03-20T21:52:45.479Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"6466697af06669003714b160","title":"Speech to Text API","slug":"listen-api","order":2,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-05-18T18:07:54.835Z","__v":0,"pages":[{"_id":"6424a4f5e2b5be000ad8feb1","api":{"method":"post","url":"/listen","auth":"required","params":[{"name":"callback","type":"string","enumValues":"","default":"","desc":"Callback URL to provide if you would like your submitted audio to be processed asynchronously. <a href=\"/docs/callback\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9590"},{"name":"callback_method","type":"string","enumValues":"","default":"","desc":"Enable a callback method. Use put or post.","required":false,"in":"query","ref":"","_id":"65af16c7ad715e0023232ca4"},{"name":"channels","type":"int","enumValues":"","default":"","desc":"Number of independent audio channels contained in submitted audio. Only read when a value is provided for encoding. <a href=\"/docs/channels\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d46668002e00485da5a8"},{"name":"custom_topic","type":"string","enumValues":"","default":"","desc":"A custom topic you want the model to detect within your input audio if present. Submit up to one hundred topics.","required":false,"in":"query","ref":"","_id":"65bd476419d0ff0071714adc"},{"name":"custom_topic_mode","type":"enum","enumValues":"extended, strict","default":"","desc":"When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param. Default: `extended`","required":false,"in":"query","ref":"","_id":"65bd476419d0ff0071714adb"},{"name":"diarize","type":"boolean","enumValues":"","default":"","desc":"Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0. Default: `false`. <a href=\"/docs/diarization\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9597"},{"name":"diarize_version","type":"string","enumValues":"","default":"","desc":"Version of the diarization feature to use. Only used when the diarization feature is enabled (<code>diarize=true</code> is passed to the API). <a href=\"/docs/diarization#enable-feature\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9596"},{"name":"dictation","type":"boolean","enumValues":"","default":"","desc":"Spoken dictation commands will be converted to their corresponding punctuation marks. e.g., comma to , Default: `false`","required":false,"in":"query","ref":"","_id":"64c192a3feb17800678de88e"},{"name":"detect_entities","type":"boolean","enumValues":"","default":"","desc":"Entity Detection identifies and extracts key entities from content in submitted audio. Default: `false`","required":false,"in":"query","ref":"","_id":"65af1613cbbb2200791b0c5e"},{"name":"detect_language","type":"boolean","enumValues":"","default":"","desc":"Detect the language of the provided audio. Default: `false`. <a href=\"/docs/language-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959c"},{"name":"detect_topics","type":"boolean","enumValues":"","default":"","desc":"Identify and extract key topics. Default: `false`. <a href=\"/docs/topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958c"},{"name":"encoding","type":"string","enumValues":"","default":"","desc":"Expected encoding of the submitted audio. If this parameter is set, `sample_rate` must also be specified. <a href=\"/docs/encoding\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d46668002e00485da59f"},{"name":"extra","type":"string","enumValues":"","default":"","desc":"To add an extra parameter in the query string and pass a key-value pair you would like to include in the response. <a href=\"/docs/extra-metadata\">Learn More</a>","required":false,"in":"query","ref":"","_id":"657a3be9e03263006441c635"},{"name":"filler_words","type":"boolean","enumValues":"","default":"","desc":"Whether to include words like \"uh\" and \"um\" in transcription output. Default: `false`. <a href=\"/docs/filler-words\">Learn More</a>","required":false,"in":"query","ref":"","_id":"64c95c351af7500066f87c44"},{"name":"intents","type":"boolean","enumValues":"","default":"","desc":"Recognizes speaker intent throughout an entire transcript. Returns a list of text segments and the intents found within each segment. <a href=\"/docs/intent-recognition\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd476419d0ff0071714ae0"},{"name":"keywords","type":"string","enumValues":"","default":"","desc":"Uncommon proper nouns or other words to transcribe that are not a part of the model's vocabulary. Can send multiple instances in query string (for example, <code>keywords=snuffalupagus:10&keywords=systrom:5.5</code>). <a href=\"/docs/keywords\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958f"},{"name":"language","type":"enum","enumValues":"da, en, en-AU, en-GB, en-IN, en-NZ, en-US, es, es-419, fr, fr-CA, hi, hi-Latn, id, it, ja, ko, nl, pl, pt, pt-BR, pt-PT, ru, sv, tr, uk, zh-CN, zh-TW","default":"","desc":"The <a target='_blank\"' href=\"https://tools.ietf.org/html/bcp47\">BCP-47</a> language tag that hints at the primary spoken language. Default: `en`. <a href=\"/docs/language\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959d"},{"name":"measurements","type":"boolean","enumValues":"","default":"","desc":"Spoken measurements will be converted to their corresponding abbreviations. e.g., milligram to mg. Default: `false`","required":false,"in":"query","ref":"","_id":"64c192a3feb17800678de88f"},{"name":"model","type":"enum","enumValues":"nova-2-general, nova-2-meeting, nova-2-phonecall, nova-2-voicemail, nova-2-finance, nova-2-conversationalai, nova-2-video, nova-2-medical, nova-2-drivethru, nova-2-automotive, whisper, <custom_id>","default":"","desc":"AI model used to process submitted audio. Default: `base-general`. <a href=\"/docs/model\">Learn More</a>","required":false,"in":"query","ref":"","_id":"643863585841a9004b0f2ea4"},{"name":"multichannel","type":"boolean","enumValues":"","default":"","desc":"Transcribe each audio channel independently. Default: `false`. <a href=\"/docs/multichannel\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9595"},{"name":"numerals","type":"boolean","enumValues":"","default":"","desc":"Convert numbers from written format (e.g., one) to numerical format (e.g., 1). Default: `false`. <a href=\"/docs/numerals\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9593"},{"name":"paragraphs","type":"boolean","enumValues":"","default":"","desc":"Split audio into paragraphs. Default: `false`. <a href=\"/docs/paragraphs\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958e"},{"name":"profanity_filter","type":"boolean","enumValues":"","default":"","desc":"Remove profanity from the transcript. Default: `false`. <a href=\"/docs/profanity-filter\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959a"},{"name":"punctuate","type":"boolean","enumValues":"","default":"","desc":"Add punctuation and capitalization to the transcript. Default: `false`. <a href=\"/docs/punctuation\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959b"},{"name":"redact","type":"enum","enumValues":"pci, numbers, true, ssn, false","default":"","desc":"Redact sensitive information, replacing redacted content with asterisks (*). Can send multiple instances in query string (for example, <code>redact=pci&redact=numbers</code>). Default: `false`. <a href=\"/docs/redaction\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9599"},{"name":"replace","type":"string","enumValues":"","default":"","desc":"Terms or phrases to search for in the submitted audio and replace. Can send multiple instances in query string (for example, <code>replace=this:that&replace=thisalso:thatalso</code>). <a href=\"/docs/find-and-replace\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9591"},{"name":"sample_rate","type":"int","enumValues":"","default":"","desc":"Sample rate of submitted audio. Required (and only read) when a value is provided for encoding. <a href=\"/docs/sample-rate\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d46668002e00485da590"},{"name":"smart_format","type":"boolean","enumValues":"","default":"","desc":"Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. Default: `false`. <a href=\"/docs/smart-format\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6449695b75044f0043ecf07d"},{"name":"search","type":"string","enumValues":"","default":"","desc":"Terms or phrases to search for in the submitted audio. Can send multiple instances in query string (for example, <code>search=speech&search=Friday</code>). <a href=\"/docs/search\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9592"},{"name":"sentiment","type":"boolean","enumValues":"","default":"","desc":"Recognizes the sentiment of the entire transcript and detects a shift in sentiment throughout the transcript. Returns a list of text segments and the sentiment found within each segment. <a href=\"/docs/sentiment-analysis\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd476419d0ff0071714ade"},{"name":"summarize","type":"string","enumValues":"","default":"","desc":"Summarize content. Default: `v2`. <a href=\"/docs/summarization\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958d"},{"name":"tag","type":"string","enumValues":"","default":"","desc":"Tag to associate with the request. <a href=\"/docs/tagging\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9589"},{"name":"topics","type":"boolean","enumValues":"","default":"","desc":"Detects topics throughout an entire transcript. Returns a list of text segments and the topics found within each segment. <a href=\"/docs/topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd476419d0ff0071714add"},{"name":"utterances","type":"boolean","enumValues":"","default":"","desc":"Segment speech into meaningful units based on gaps in speech. Default: `false`. <a href=\"/docs/utterances\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958b"},{"name":"utt_split","type":"float","enumValues":"","default":"","desc":"Length of time in seconds used to split utterances. Default: `0.8`. <a href=\"/docs/utterance-split\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958a"},{"name":"version","type":"enum","enumValues":"latest, <version_id>","default":"","desc":"Version of the model to use. Default: `latest`. <a href=\"/docs/version\">Learn More</a>","required":false,"in":"query","ref":"","_id":"643863585841a9004b0f2ea3"},{"name":"RAW_BODY","type":"string","enumValues":"","default":"","desc":"You can send RAW audio directly to this API endpoint.","required":false,"in":"body","ref":"","_id":"6439b5aad43ca60066067e05"},{"name":"Content-Type","type":"string","enumValues":"","default":"audio/*","desc":"","required":false,"in":"header","ref":"","_id":"658d6793cbad49001c37e4f4"},{"name":"Accept","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"658d6793cbad49001c37e4f3"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl \\\n --request POST \\\n --header 'Authorization: Token YOUR_DEEPGRAM_API_KEY' \\\n --header 'Content-Type: audio/wav' \\\n --data-binary @youraudio.wav \\\n --url 'https://api.deepgram.com/v1/listen'","language":"curl"},{"code":"# Install the Deepgram Python SDK\n# pip install deepgram-sdk==3.*\n\nfrom deepgram import (\n DeepgramClient,\n PrerecordedOptions,\n FileSource,\n)\n\nAUDIO_FILE = \"YOUR_LOCAL_FILE.mp3\"\n\n\ndef main():\n try:\n deepgram = DeepgramClient(\"DEEPGRAM_API_KEY\")\n\n with open(AUDIO_FILE, \"rb\") as file:\n buffer_data = file.read()\n\n payload: FileSource = {\n \"buffer\": buffer_data,\n }\n\n options = PrerecordedOptions(\n model=\"nova-2\",\n smart_format=True,\n )\n\n response = deepgram.listen.rest.v(\"1\").transcribe_file(payload, options)\n\n print(response.to_json(indent=4))\n\n except Exception as e:\n print(f\"Exception: {e}\")\n\n\nif __name__ == \"__main__\":\n main()","language":"python","name":"SDK"},{"code":"// Install the Deepgram JS SDK\n// npm install @deepgram/sdk\n\nconst { createClient } = require(\"@deepgram/sdk\");\nconst fs = require(\"fs\");\n\nconst transcribeFile = async () => {\n const deepgram = createClient(\"DEEPGRAM_API_KEY\");\n const { result, error } = await deepgram.listen.prerecorded.transcribeFile(\n fs.readFileSync(\"YOUR_LOCAL_FILE.mp3\"),\n {\n model: \"nova-2\",\n smart_format: true,\n }\n );\n\n if (error) throw error;\n if (!error) console.dir(result, { depth: null });\n};\n\ntranscribeFile();","language":"javascript","name":"SDK"},{"code":"// Install the Deepgram Go SDK\n// go get github.com/deepgram/deepgram-go-sdk@<current version>\n\npackage main\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\n\tprettyjson \"github.com/hokaccha/go-prettyjson\"\n\n\tapi \"github.com/deepgram/deepgram-go-sdk/pkg/api/listen/v1/rest\"\n\tinterfaces \"github.com/deepgram/deepgram-go-sdk/pkg/client/interfaces\"\n\tclient \"github.com/deepgram/deepgram-go-sdk/pkg/client/listen\"\n)\n\nconst (\n\tfilePath string = \"YOUR_AUDIO_FILE.mp3\"\n)\n\nfunc main() {\n\tclient.InitWithDefault()\n\n\tctx := context.Background()\n\n\toptions := interfaces.PreRecordedTranscriptionOptions{\n\t\tModel: \"nova-2\",\n\t\tSmartFormat: true,\n\t}\n\n\t// NOTE: you can set your API KEY in your bash profile by typing the following line in your shell:\n\t// export DEEPGRAM_API_KEY = \"YOUR_DEEPGRAM_API_KEY\"\n\tc := client.NewWithDefaults()\n\tdg := api.New(c)\n\n\tres, err := dg.FromFile(ctx, filePath, options)\n\tif err != nil {\n\t\tfmt.Printf(\"FromStream failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tdata, err := json.Marshal(res)\n\tif err != nil {\n\t\tfmt.Printf(\"json.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tprettyJson, err := prettyjson.Format(data)\n\tif err != nil {\n\t\tfmt.Printf(\"prettyjson.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\tfmt.Printf(\"\\n\\nResult:\\n%s\\n\\n\", prettyJson)\n}","language":"go","name":"SDK"},{"code":"// Install the Deepgram .NET SDK\n// dotnet add package Deepgram\n\nusing Deepgram.Models.Listen.v1.REST;\n\nLibrary.Initialize();\n\n// use the client factory with a API Key set with the \"DEEPGRAM_API_KEY\" environment variable\nvar deepgramClient = ClientFactory.CreateListenRESTClient();\n\n// check to see if the file exists\nif (!File.Exists(@\"Bueller-Life-moves-pretty-fast.wav\"))\n{\n Console.WriteLine(\"Error: File 'Bueller-Life-moves-pretty-fast.wav' not found.\");\n return;\n}\n\nvar audioData = File.ReadAllBytes(@\"Bueller-Life-moves-pretty-fast.wav\");\nvar response = await deepgramClient.TranscribeFile(\n audioData,\n new PreRecordedSchema()\n {\n Model = \"nova-2\",\n SmartFormat = true,\n });\n\nConsole.WriteLine($\"\\n\\n{response}\\n\\n\");\nConsole.WriteLine(\"Press any key to exit...\");\nConsole.ReadKey();\n\n// Teardown Library\nLibrary.Terminate();\n","language":"csharp","name":"SDK"},{"code":"import requests\n\n# Define the URL for the Deepgram API endpoint\nurl = \"https://api.deepgram.com/v1/listen\"\n\n# Define the headers for the HTTP request\nheaders = {\n \"Authorization\": \"Token DEEPGRAM_API_KEY\",\n \"Content-Type\": \"audio/*\"\n}\n\n# Get the audio file\nwith open(\"/path/to/youraudio.wav\", \"rb\") as audio_file:\n # Make the HTTP request\n response = requests.post(url, headers=headers, data=audio_file)\n\nprint(response.json())","language":"python","name":"Requests"},{"code":"import Foundation\n\n// Specify the URL for the Deepgram API endpoint\nlet url = URL(string: \"https://api.deepgram.com/v1/listen\")!\n\n// Specify the path to the audio file\nlet audioFilePath = \"/path/to/youraudio.wav\"\n\n// Read the audio file as binary data\nguard let audioData = FileManager.default.contents(atPath: audioFilePath) else {\n print(\"Error: Unable to read audio file\")\n exit(1)\n}\n\n// Create the URLRequest object\nvar request = URLRequest(url: url)\nrequest.httpMethod = \"POST\"\n\n// Set request headers\nrequest.setValue(\"Token DEEPGRAM_API_KEY\", forHTTPHeaderField: \"Authorization\") // Replace YOUR_DEEPGRAM_API_KEY with your actual API key\nrequest.setValue(\"audio/wav\", forHTTPHeaderField: \"Content-Type\")\n\n// Set request body with audio data\nrequest.httpBody = audioData\n\n// Create URLSession task to perform the request\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in\n if let error = error {\n print(\"Error: \\(error)\")\n return\n }\n \n guard let httpResponse = response as? HTTPURLResponse, (200...299).contains(httpResponse.statusCode) else {\n print(\"Error: Invalid response\")\n return\n }\n \n if let data = data {\n if let responseBody = String(data: data, encoding: .utf8) {\n print(\"Response: \\(responseBody)\")\n } else {\n print(\"Error: Unable to parse response body\")\n }\n } else {\n print(\"Error: No response data\")\n }\n}\n\n// Start the URLSession task\ntask.resume()\n\n// Keep the program running until the URLSession task completes\nRunLoop.main.run()\n","language":"swift","name":null},{"code":" Code example coming soon","language":"r"},{"code":" Code example coming soon","language":"powershell"},{"code":" Code example coming soon","language":"clojure"},{"code":"import java.io.*;\nimport java.net.*;\n\npublic class Main {\n public static void main(String[] args) {\n try {\n // Specify the URL for the Deepgram API endpoint\n URL url = new URL(\"https://api.deepgram.com/v1/listen\");\n\n // Open a connection to the URL\n HttpURLConnection connection = (HttpURLConnection) url.openConnection();\n\n // Set the request method to POST\n connection.setRequestMethod(\"POST\");\n\n // Set request headers\n connection.setRequestProperty(\"Authorization\", \"Token DEEPGRAM_API_KEY\"); // Replace YOUR_DEEPGRAM_API_KEY\n // with your actual API key\n connection.setRequestProperty(\"Content-Type\", \"audio/wav\");\n\n // Enable output (sending data to the server)\n connection.setDoOutput(true);\n\n // Get the output stream of the connection\n OutputStream outputStream = connection.getOutputStream();\n\n // Read the audio file as binary data and write it to the output stream\n FileInputStream fileInputStream = new FileInputStream(\"youraudio.wav\"); // Replace \"youraudio.wav\" with the path\n // to your audio file\n byte[] buffer = new byte[1024];\n int bytesRead;\n while ((bytesRead = fileInputStream.read(buffer)) != -1) {\n outputStream.write(buffer, 0, bytesRead);\n }\n fileInputStream.close();\n\n // Close the output stream\n outputStream.close();\n\n // Get the response code from the server\n int responseCode = connection.getResponseCode();\n\n // Check if the request was successful (status code 200)\n if (responseCode == HttpURLConnection.HTTP_OK) {\n // Read and print the response from the server\n BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));\n String inputLine;\n StringBuffer response = new StringBuffer();\n while ((inputLine = in.readLine()) != null) {\n response.append(inputLine);\n }\n in.close();\n System.out.println(\"Response: \" + response.toString());\n } else {\n System.out.println(\"HTTP request failed with status code \" + responseCode);\n }\n\n // Disconnect the connection\n connection.disconnect();\n } catch (IOException e) {\n e.printStackTrace();\n }\n }\n}\n","language":"java","name":""},{"code":"<?php\n\n// API endpoint URL\n$url = \"https://api.deepgram.com/v1/listen\";\n\n// API key\n$apiKey = \"DEEPGRAM_API_KEY\";\n\n// Path to the audio file\n$audioFilePath = \"youraudio.wav\"; // Replace \"youraudio.wav\" with the path to your audio file\n\n// Initialize cURL session\n$ch = curl_init();\n\n// Set cURL options\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, file_get_contents($audioFilePath));\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n 'Authorization: Token ' . $apiKey,\n 'Content-Type: audio/wav'\n));\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n// Execute cURL request\n$response = curl_exec($ch);\n\n// Check for errors\nif ($response === false) {\n echo 'cURL error: ' . curl_error($ch);\n} else {\n // Print the response\n echo $response;\n}\n\n// Close cURL session\ncurl_close($ch);\n\n?>\n","language":"php"},{"code":"require 'net/http'\n\n# Define the URL for the Deepgram API endpoint\nurl = URI.parse(\"https://api.deepgram.com/v1/listen\")\n\n# Define the path to the audio file\naudio_file_path = \"youraudio.wav\" # Replace \"youraudio.wav\" with the path to your audio file\n\n# Read the audio file as binary data\naudio_data = File.binread(audio_file_path)\n\n# Create a new Net::HTTP object\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\n# Create a new HTTP request\nrequest = Net::HTTP::Post.new(url)\n\n# Set request headers\nrequest[\"Authorization\"] = \"Token DEEPGRAM_API_KEY\" # Replace YOUR_DEEPGRAM_API_KEY with your actual API key\nrequest[\"Content-Type\"] = \"audio/wav\"\n\n# Set request body with audio data\nrequest.body = audio_data\n\n# Send the request and get the response\nresponse = http.request(request)\n\n# Print the response body\nputs response.body\n","language":"ruby","name":"net/http"},{"code":"require 'httparty'\n\n# Define the URL for the Deepgram API endpoint\nurl = 'https://api.deepgram.com/v1/listen'\n\n# Define the path to the audio file\naudio_file_path = 'youraudio.wav' # Replace 'youraudio.wav' with the path to your audio file\n\n# Read the audio file as binary data\naudio_data = File.binread(audio_file_path)\n\n# Define the headers\nheaders = {\n 'Authorization' => 'Token DEEPGRAM_API_KEY', # Replace YOUR_DEEPGRAM_API_KEY with your actual API key\n 'Content-Type' => 'audio/wav'\n}\n\n# Make the HTTP POST request using HTTParty\nresponse = HTTParty.post(\n url,\n headers: headers,\n body: audio_data\n)\n\n# Print the response body\nputs response.body\n","language":"ruby","name":"httparty"},{"code":" Code example coming soon","language":"ocaml"},{"code":" Code example coming soon","language":"objectivec"},{"code":"Code example coming soon","language":"kotlin"},{"code":"#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <curl/curl.h>\n\nint main(void) {\n CURL *curl;\n CURLcode res;\n\n // Initialize libcurl\n curl = curl_easy_init();\n if(curl) {\n // Set the request headers\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\"); // Replace YOUR_DEEPGRAM_API_KEY with your actual API key\n headers = curl_slist_append(headers, \"Content-Type: audio/wav\");\n\n // Set the request URL\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/listen\");\n // Set the request headers\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n\n // Set the request data\n FILE *file = fopen(\"youraudio.wav\", \"rb\"); // Replace \"youraudio.wav\" with the path to your audio file\n if (!file) {\n fprintf(stderr, \"Error: Unable to open audio file\\n\");\n return 1;\n }\n fseek(file, 0, SEEK_END);\n long file_size = ftell(file);\n rewind(file);\n char *buffer = malloc(file_size);\n if (!buffer) {\n fprintf(stderr, \"Error: Memory allocation failed\\n\");\n fclose(file);\n return 1;\n }\n if (fread(buffer, 1, file_size, file) != file_size) {\n fprintf(stderr, \"Error: Failed to read audio file\\n\");\n fclose(file);\n free(buffer);\n return 1;\n }\n fclose(file);\n\n // Set the request data as binary\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, buffer);\n curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, file_size);\n\n // Perform the request\n res = curl_easy_perform(curl);\n // Check for errors\n if(res != CURLE_OK)\n fprintf(stderr, \"curl_easy_perform() failed: %s\\n\",\n curl_easy_strerror(res));\n\n // Cleanup\n curl_slist_free_all(headers);\n curl_easy_cleanup(curl);\n free(buffer);\n }\n return 0;\n}\n","language":"c"},{"code":"#include <iostream>\n#include <curl/curl.h>\n#include <fstream>\n#include <string>\n\nint main() {\n // Initialize libcurl\n curl_global_init(CURL_GLOBAL_ALL);\n\n // Create a CURL handle\n CURL *curl = curl_easy_init();\n if (curl) {\n // Set the request URL\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/listen\");\n\n // Set the request headers\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\"); // Replace YOUR_DEEPGRAM_API_KEY with your actual API key\n headers = curl_slist_append(headers, \"Content-Type: audio/wav\");\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n\n // Read the audio file as binary data\n std::ifstream file(\"youraudio.wav\", std::ios::binary | std::ios::ate);\n if (!file.is_open()) {\n std::cerr << \"Failed to open audio file\" << std::endl;\n return 1;\n }\n std::streamsize file_size = file.tellg();\n file.seekg(0, std::ios::beg);\n std::string audio_data(file_size, '\\0');\n if (!file.read(&audio_data[0], file_size)) {\n std::cerr << \"Failed to read audio file\" << std::endl;\n return 1;\n }\n file.close();\n\n // Set the request data as binary\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, audio_data.c_str());\n curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, audio_data.size());\n\n // Perform the request\n CURLcode res = curl_easy_perform(curl);\n\n // Check for errors\n if (res != CURLE_OK) {\n std::cerr << \"curl_easy_perform() failed: \" << curl_easy_strerror(res) << std::endl;\n }\n\n // Cleanup\n curl_easy_cleanup(curl);\n curl_slist_free_all(headers);\n } else {\n std::cerr << \"Failed to initialize libcurl\" << std::endl;\n }\n\n // Cleanup libcurl\n curl_global_cleanup();\n\n return 0;\n}\n","language":"cplusplus"},{"code":"import http.client\nimport json\n\n# Define the URL for the Deepgram API endpoint\nurl = \"api.deepgram.com\"\n\n# Define the path to the audio file\naudio_file_path = \"/path/to/youraudio.wav\" # Replace with the path to your audio file\n\n# Read the audio file as binary data\nwith open(audio_file_path, \"rb\") as audio_file:\n audio_data = audio_file.read()\n\n# Define request headers\nheaders = {\n \"Authorization\":\n \"Token DEEPGRAM_API_KEY\", # Replace with your Deepgram API key\n \"Content-Type\": \"audio/*\"\n}\n\n# Create a connection to the API endpoint\nconn = http.client.HTTPSConnection(url)\n\n# Define the request body\nbody = audio_data\n\n# Send the POST request\nconn.request(\"POST\", \"/v1/listen\", body, headers)\n\n# Get the response\nresponse = conn.getresponse()\n\n# Read and print the response data\nresponse_data = response.read()\nprint(json.loads(response_data))\n\n# Close the connection\nconn.close()\n","language":"python","name":"HTTP client"},{"code":"const axios = require(\"axios\");\nconst fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioFilePath = \"YOUR_AUDIO.wav\"; // Replace with the path to your audio file\n\n// Read the audio file as binary data\nconst audioData = fs.readFileSync(audioFilePath);\n\n// Define request headers\nconst headers = {\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"audio/wav\",\n};\n\n// Make the POST request using axios\naxios\n .post(url, audioData, { headers: headers })\n .then((response) => {\n console.log(response.data); // Handle response data\n })\n .catch((error) => {\n console.error(\"Error:\", error); // Handle errors\n });\n","language":"javascript","name":"axios"},{"code":"const https = require(\"https\");\nconst fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioFilePath = \"/path/to/youraudio.wav\"; // Replace with the path to your audio file\n\n// Read the audio file as binary data\nconst audioData = fs.readFileSync(audioFilePath);\n\n// Define request headers\nconst headers = {\n Accept: \"application/json\",\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"audio/wav\",\n};\n\n// Define request options\nconst options = {\n method: \"POST\",\n headers: headers,\n};\n\n// Create a HTTPS request\nconst req = https.request(url, options, (res) => {\n let responseBody = \"\";\n\n // Concatenate chunks of response data\n res.on(\"data\", (chunk) => {\n responseBody += chunk;\n });\n\n // When the response ends, parse and log the response body\n res.on(\"end\", () => {\n console.dir(JSON.parse(responseBody), { depth: null }); // Handle response data\n });\n});\n\n// Handle request errors\nreq.on(\"error\", (error) => {\n console.error(\"Error:\", error); // Handle errors\n});\n\n// Write the audio data to the request body\nreq.write(audioData);\n\n// End the request\nreq.end();\n","language":"javascript","name":"https"},{"code":"const fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioFilePath = \"/path/to/youraudio.wav\"; // Replace with the path to your audio file\n\n// Read the audio file as binary data\nfs.readFile(audioFilePath, (err, audioData) => {\n if (err) {\n console.error(\"Error reading audio file:\", err);\n return;\n }\n\n // Define request headers\n const headers = {\n Accept: \"application/json\",\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"audio/wav\",\n };\n\n // Define fetch options\n const options = {\n method: \"POST\",\n headers: headers,\n body: audioData,\n };\n\n // Make the POST request using fetch\n fetch(url, options)\n .then((response) => {\n if (!response.ok) {\n throw new Error(\"Failed to make request:\", response.statusText);\n }\n return response.json();\n })\n .then((data) => {\n console.dir(data, { depth: null }); // Handle response data\n })\n .catch((error) => {\n console.error(\"Error:\", error); // Handle errors\n });\n});\n","language":"javascript","name":"fetch"},{"code":"import fs from \"fs\";\nimport fetch from \"node-fetch\";\n\nconst url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioFilePath = \"/path/to/youraudio.wav\"; // Replace with the path to your audio file\n\n// Read the audio file as binary data\nfs.readFile(audioFilePath, (err, audioData) => {\n if (err) {\n console.error(\"Error reading audio file:\", err);\n return;\n }\n\n // Define request headers\n const headers = {\n Accept: \"application/json\",\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"audio/wav\",\n };\n\n // Make the POST request using node-fetch\n fetch(url, {\n method: \"POST\",\n headers: headers,\n body: audioData,\n })\n .then((response) => {\n if (!response.ok) {\n throw new Error(\"Failed to make request:\", response.statusText);\n }\n return response.json();\n })\n .then((data) => {\n console.dir(data, { depth: null }); // Handle response data\n })\n .catch((error) => {\n console.error(\"Error:\", error); // Handle errors\n });\n});\n","language":"javascript","name":"node-fetch"},{"code":"package main\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n)\n\nfunc main() {\n\t// Specify the URL\n\turl := \"https://api.deepgram.com/v1/listen\"\n\n\t// Open the audio file\n\tfile, err := os.Open(\"youraudio.wav\")\n\tif err != nil {\n\t\tfmt.Println(\"Error opening file:\", err)\n\t\treturn\n\t}\n\tdefer file.Close()\n\n\t// Prepare the request body\n\tbody := &bytes.Buffer{}\n\t_, err = io.Copy(body, file)\n\tif err != nil {\n\t\tfmt.Println(\"Error reading file:\", err)\n\t\treturn\n\t}\n\n\t// Create a new HTTP request with the specified URL and body\n\treq, err := http.NewRequest(\"POST\", url, body)\n\tif err != nil {\n\t\tfmt.Println(\"Error creating request:\", err)\n\t\treturn\n\t}\n\n\t// Set the request headers\n\treq.Header.Set(\"Authorization\", \"Token DEEPGRAM_API_KEY\")\n\treq.Header.Set(\"Content-Type\", \"audio/wav\")\n\n\t// Send the request\n\tclient := &http.Client{}\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(\"Error sending request:\", err)\n\t\treturn\n\t}\n\tdefer resp.Body.Close()\n\n\t// Print the response status code\n\tfmt.Println(\"Response status code:\", resp.Status)\n\n\t// Read and print the response body\n\tvar responseBody bytes.Buffer\n\t_, err = io.Copy(&responseBody, resp.Body)\n\tif err != nil {\n\t\tfmt.Println(\"Error reading response body:\", err)\n\t\treturn\n\t}\n\tfmt.Println(\"Response body:\", responseBody.String())\n}\n","language":"go","name":"net/http"},{"code":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main(string[] args)\n {\n // Path to the audio file\n string audioFilePath = \"youraudio.wav\"; // Replace with the path to your audio file\n\n // URL to which you want to send the request\n string url = \"https://api.deepgram.com/v1/listen\"; // Replace with your actual endpoint URL\n\n // API Key\n string apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\n\n // Create an instance of HttpClient\n using (HttpClient httpClient = new HttpClient())\n {\n try\n {\n // Read the audio file as binary data\n byte[] audioData = await File.ReadAllBytesAsync(audioFilePath);\n\n // Prepare the HTTP request content\n HttpContent content = new ByteArrayContent(audioData);\n\n // Set the content type header\n content.Headers.Add(\"Content-Type\", \"audio/wav\");\n\n // Add Authorization header\n httpClient.DefaultRequestHeaders.Add(\"Authorization\", \"Token \" + apiKey);\n\n // Send the POST request\n HttpResponseMessage response = await httpClient.PostAsync(url, content);\n\n // Check if the request was successful\n if (response.IsSuccessStatusCode)\n {\n // Read the response content (transcription)\n string transcription = await response.Content.ReadAsStringAsync();\n Console.WriteLine(\"Transcription:\");\n Console.WriteLine(transcription);\n }\n else\n {\n Console.WriteLine(\"Request failed with status code: \" + response.StatusCode);\n }\n }\n catch (Exception ex)\n {\n Console.WriteLine(\"Error: \" + ex.Message);\n }\n }\n }\n}\n","language":"csharp","name":"HTTPCLIENT"}]},"results":{"codes":[{"code":"{\"metadata\":{\"transaction_key\":\"deprecated\",\"request_id\":\"4399e2a5-2b29-4e1e-9456-79043cc88d0a\",\"sha256\":\"362c1aae4da8c8952bd29fdd5eda25f7c3e92b040b5c31f741a0e0df7c061608\",\"created\":\"2023-05-30T14:17:36.953Z\",\"duration\":169.802,\"channels\":1,\"models\":[\"96a295ec-6336-43d5-b1cb-1e48b5e6d9a4\"],\"model_info\":{\"96a295ec-6336-43d5-b1cb-1e48b5e6d9a4\":{\"name\":\"general\",\"version\":\"2023-02-22.3\",\"arch\":\"base\"}}},\"results\":{\"channels\":[{\"alternatives\":[{\"transcript\":\"and jessica christina we are so proud you you're gonna do great today we'll be waiting for you here in a couple hours when you get home i'm gonna hand you over to stephanie now have a great great eva drew thank you so much and our pleasure working with you this morning and i'm working on getting that easy hatch open and i can report it's opened and s thank drew thank you so much on your dc take your power switches to bat stagger switch throws and expect a warning tone final steps where they begin the space copy check display switch functional tracy how important is this the the guiding it the isn't like seems like a lot to remember on your own absolutely take power e b one e two two switches to us o f yeah christina jessica have enough work with their hands and feet and their brain outside that it really helps to have someone like stephanie you power both off connector your from your dc and s the in the pouch kinda the interrupt so not only does stephanie thirty eight am central time a little ahead of schedule about twelve minutes but that gets us started on today's historic space walk morgan there wishing the crew luck the made pouch and dc cover closed copy e two\",\"confidence\":0.97326756,\"words\":[{\"word\":\"and\",\"start\":3.067842,\"end\":3.567842,\"confidence\":0.9807649},{\"word\":\"jessica\",\"start\":4.8208942,\"end\":5.2193155,\"confidence\":0.9766418},{\"word\":\"christina\",\"start\":5.538052,\"end\":5.777105,\"confidence\":0.9684238},{\"word\":\"we\",\"start\":6.095842,\"end\":6.4145784,\"confidence\":0.9931241},{\"word\":\"are\",\"start\":6.4145784,\"end\":6.892684,\"confidence\":0.9892484},{\"word\":\"so\",\"start\":6.892684,\"end\":7.1317363,\"confidence\":0.98863983},{\"word\":\"proud\",\"start\":7.1317363,\"end\":7.4504733,\"confidence\":0.99803776},{\"word\":\"you\",\"start\":7.4504733,\"end\":7.585,\"confidence\":0.94981164},{\"word\":\"you're\",\"start\":8.662,\"end\":8.901333,\"confidence\":0.9753204},{\"word\":\"gonna\",\"start\":8.901333,\"end\":9.140667,\"confidence\":0.96902674},{\"word\":\"do\",\"start\":9.140667,\"end\":9.300222,\"confidence\":0.97186357},{\"word\":\"great\",\"start\":9.300222,\"end\":9.619333,\"confidence\":0.9995757},{\"word\":\"today\",\"start\":9.619333,\"end\":9.699111,\"confidence\":0.9982907},{\"word\":\"we'll\",\"start\":9.938444,\"end\":10.098,\"confidence\":0.9700654},{\"word\":\"be\",\"start\":10.098,\"end\":10.257555,\"confidence\":0.99841106},{\"word\":\"waiting\",\"start\":10.257555,\"end\":10.496889,\"confidence\":0.99966013},{\"word\":\"for\",\"start\":10.496889,\"end\":10.656445,\"confidence\":0.9985917},{\"word\":\"you\",\"start\":10.656445,\"end\":10.816,\"confidence\":0.99760073},{\"word\":\"here\",\"start\":10.816,\"end\":10.975555,\"confidence\":0.9821878},{\"word\":\"in\",\"start\":10.975555,\"end\":11.055333,\"confidence\":0.98402536},{\"word\":\"a\",\"start\":11.055333,\"end\":11.214889,\"confidence\":0.99080414},{\"word\":\"couple\",\"start\":11.214889,\"end\":11.454222,\"confidence\":0.99982774},{\"word\":\"hours\",\"start\":11.454222,\"end\":11.693556,\"confidence\":0.9998036},{\"word\":\"when\",\"start\":11.693556,\"end\":11.773334,\"confidence\":0.9985682},{\"word\":\"you\",\"start\":11.773334,\"end\":11.932889,\"confidence\":0.99776137},{\"word\":\"get\",\"start\":11.932889,\"end\":12.092444,\"confidence\":0.9987956},{\"word\":\"home\",\"start\":12.092444,\"end\":12.252,\"confidence\":0.99989545},{\"word\":\"i'm\",\"start\":12.810444,\"end\":12.969999,\"confidence\":0.9968612},{\"word\":\"gonna\",\"start\":12.969999,\"end\":13.209333,\"confidence\":0.98595315},{\"word\":\"hand\",\"start\":13.209333,\"end\":13.289111,\"confidence\":0.9997478},{\"word\":\"you\",\"start\":13.289111,\"end\":13.448667,\"confidence\":0.99819785},{\"word\":\"over\",\"start\":13.448667,\"end\":13.528444,\"confidence\":0.9993493},{\"word\":\"to\",\"start\":13.528444,\"end\":13.688,\"confidence\":0.99777526},{\"word\":\"stephanie\",\"start\":13.847555,\"end\":14.246445,\"confidence\":0.9936746},{\"word\":\"now\",\"start\":14.246445,\"end\":14.326222,\"confidence\":0.98286617},{\"word\":\"have\",\"start\":15.860001,\"end\":16.02,\"confidence\":0.9736103},{\"word\":\"a\",\"start\":16.02,\"end\":16.18,\"confidence\":0.9868292},{\"word\":\"great\",\"start\":16.18,\"end\":16.58,\"confidence\":0.97828484},{\"word\":\"great\",\"start\":16.58,\"end\":16.82,\"confidence\":0.9986426},{\"word\":\"eva\",\"start\":16.900002,\"end\":17.380001,\"confidence\":0.81174904},{\"word\":\"drew\",\"start\":17.7,\"end\":17.86,\"confidence\":0.96023065},{\"word\":\"thank\",\"start\":18.02,\"end\":18.18,\"confidence\":0.99756265},{\"word\":\"you\",\"start\":18.18,\"end\":18.42,\"confidence\":0.9986058},{\"word\":\"so\",\"start\":18.42,\"end\":18.58,\"confidence\":0.99923587},{\"word\":\"much\",\"start\":18.58,\"end\":18.82,\"confidence\":0.9993931},{\"word\":\"and\",\"start\":19.300001,\"end\":19.460001,\"confidence\":0.8400723},{\"word\":\"our\",\"start\":19.460001,\"end\":19.7,\"confidence\":0.97326756},{\"word\":\"pleasure\",\"start\":19.7,\"end\":19.94,\"confidence\":0.9969959},{\"word\":\"working\",\"start\":19.94,\"end\":20.18,\"confidence\":0.9986186},{\"word\":\"with\",\"start\":20.18,\"end\":20.34,\"confidence\":0.99988437},{\"word\":\"you\",\"start\":20.34,\"end\":20.5,\"confidence\":0.99919075},{\"word\":\"this\",\"start\":20.5,\"end\":20.66,\"confidence\":0.99971086},{\"word\":\"morning\",\"start\":20.66,\"end\":21.060001,\"confidence\":0.99977344},{\"word\":\"and\",\"start\":21.060001,\"end\":21.460001,\"confidence\":0.99385434},{\"word\":\"i'm\",\"start\":21.460001,\"end\":21.54,\"confidence\":0.6949018},{\"word\":\"working\",\"start\":21.54,\"end\":21.78,\"confidence\":0.9936865},{\"word\":\"on\",\"start\":21.78,\"end\":21.94,\"confidence\":0.9969817},{\"word\":\"getting\",\"start\":21.94,\"end\":22.18,\"confidence\":0.9988746},{\"word\":\"that\",\"start\":22.18,\"end\":22.26,\"confidence\":0.94096375},{\"word\":\"easy\",\"start\":22.34,\"end\":22.66,\"confidence\":0.4179583},{\"word\":\"hatch\",\"start\":22.66,\"end\":22.900002,\"confidence\":0.80127984},{\"word\":\"open\",\"start\":22.900002,\"end\":23.14,\"confidence\":0.97084236},{\"word\":\"and\",\"start\":23.714266,\"end\":23.873285,\"confidence\":0.986055},{\"word\":\"i\",\"start\":23.952795,\"end\":24.032305,\"confidence\":0.8785544},{\"word\":\"can\",\"start\":24.032305,\"end\":24.350344,\"confidence\":0.78802234},{\"word\":\"report\",\"start\":24.350344,\"end\":24.850344,\"confidence\":0.7833075},{\"word\":\"it's\",\"start\":25.702011,\"end\":25.94054,\"confidence\":0.43321013},{\"word\":\"opened\",\"start\":25.94054,\"end\":26.25858,\"confidence\":0.939075},{\"word\":\"and\",\"start\":26.25858,\"end\":26.576618,\"confidence\":0.96032727},{\"word\":\"s\",\"start\":26.576618,\"end\":26.894657,\"confidence\":0.9379913},{\"word\":\"thank\",\"start\":28.961912,\"end\":29.120934,\"confidence\":0.9708335},{\"word\":\"drew\",\"start\":29.438972,\"end\":29.597992,\"confidence\":0.9918337},{\"word\":\"thank\",\"start\":30.07505,\"end\":30.23407,\"confidence\":0.9985739},{\"word\":\"you\",\"start\":30.23407,\"end\":30.472599,\"confidence\":0.9980198},{\"word\":\"so\",\"start\":30.472599,\"end\":30.631618,\"confidence\":0.99978584},{\"word\":\"much\",\"start\":30.631618,\"end\":30.870148,\"confidence\":0.9996094},{\"word\":\"on\",\"start\":38.223537,\"end\":38.383133,\"confidence\":0.928422},{\"word\":\"your\",\"start\":38.383133,\"end\":38.46293,\"confidence\":0.9850849},{\"word\":\"dc\",\"start\":38.622528,\"end\":39.122528,\"confidence\":0.5699869},{\"word\":\"take\",\"start\":39.83451,\"end\":39.99412,\"confidence\":0.99883646},{\"word\":\"your\",\"start\":39.99412,\"end\":40.233532,\"confidence\":0.9995505},{\"word\":\"power\",\"start\":40.233532,\"end\":40.712357,\"confidence\":0.99378115},{\"word\":\"switches\",\"start\":40.712357,\"end\":40.871964,\"confidence\":0.99915934},{\"word\":\"to\",\"start\":40.871964,\"end\":41.111374,\"confidence\":0.99873084},{\"word\":\"bat\",\"start\":41.111374,\"end\":41.27098,\"confidence\":0.7712309},{\"word\":\"stagger\",\"start\":41.749805,\"end\":42.148827,\"confidence\":0.98734725},{\"word\":\"switch\",\"start\":42.148827,\"end\":42.388237,\"confidence\":0.936786},{\"word\":\"throws\",\"start\":42.388237,\"end\":42.627647,\"confidence\":0.97849435},{\"word\":\"and\",\"start\":42.627647,\"end\":42.946865,\"confidence\":0.99815005},{\"word\":\"expect\",\"start\":42.946865,\"end\":43.106472,\"confidence\":0.99575573},{\"word\":\"a\",\"start\":43.106472,\"end\":43.26608,\"confidence\":0.9927196},{\"word\":\"warning\",\"start\":43.26608,\"end\":43.505493,\"confidence\":0.9998263},{\"word\":\"tone\",\"start\":43.505493,\"end\":43.744904,\"confidence\":0.99915254},{\"word\":\"final\",\"start\":64.42,\"end\":64.82,\"confidence\":0.99228233},{\"word\":\"steps\",\"start\":64.82,\"end\":65.06,\"confidence\":0.984963},{\"word\":\"where\",\"start\":65.06,\"end\":65.22,\"confidence\":0.49309498},{\"word\":\"they\",\"start\":65.22,\"end\":65.46,\"confidence\":0.96069825},{\"word\":\"begin\",\"start\":65.46,\"end\":65.54,\"confidence\":0.9870433},{\"word\":\"the\",\"start\":65.54,\"end\":65.7,\"confidence\":0.9080708},{\"word\":\"space\",\"start\":65.7,\"end\":65.86,\"confidence\":0.9228741},{\"word\":\"copy\",\"start\":66.1,\"end\":66.26,\"confidence\":0.8863323},{\"word\":\"check\",\"start\":66.659996,\"end\":67.06,\"confidence\":0.99407756},{\"word\":\"display\",\"start\":67.06,\"end\":67.3,\"confidence\":0.9952095},{\"word\":\"switch\",\"start\":67.3,\"end\":67.78,\"confidence\":0.9902741},{\"word\":\"functional\",\"start\":67.78,\"end\":68.1,\"confidence\":0.98246896},{\"word\":\"tracy\",\"start\":74.18979,\"end\":74.42948,\"confidence\":0.9510427},{\"word\":\"how\",\"start\":74.58928,\"end\":74.90887,\"confidence\":0.9951479},{\"word\":\"important\",\"start\":74.90887,\"end\":75.06866,\"confidence\":0.9719207},{\"word\":\"is\",\"start\":75.06866,\"end\":75.228455,\"confidence\":0.9141554},{\"word\":\"this\",\"start\":75.228455,\"end\":75.46814,\"confidence\":0.7431963},{\"word\":\"the\",\"start\":75.46814,\"end\":75.96814,\"confidence\":0.45991337},{\"word\":\"the\",\"start\":76.74649,\"end\":76.98618,\"confidence\":0.38744238},{\"word\":\"guiding\",\"start\":76.98618,\"end\":77.225876,\"confidence\":0.6274184},{\"word\":\"it\",\"start\":77.225876,\"end\":77.385666,\"confidence\":0.33466855},{\"word\":\"the\",\"start\":77.385666,\"end\":77.54546,\"confidence\":0.33121714},{\"word\":\"isn't\",\"start\":77.54546,\"end\":77.92,\"confidence\":0.50690776},{\"word\":\"like\",\"start\":78.199135,\"end\":78.35864,\"confidence\":0.34808892},{\"word\":\"seems\",\"start\":78.35864,\"end\":78.51815,\"confidence\":0.9660647},{\"word\":\"like\",\"start\":78.51815,\"end\":78.677666,\"confidence\":0.99579394},{\"word\":\"a\",\"start\":78.677666,\"end\":78.83717,\"confidence\":0.90933007},{\"word\":\"lot\",\"start\":78.83717,\"end\":78.99668,\"confidence\":0.3617743},{\"word\":\"to\",\"start\":78.99668,\"end\":79.15619,\"confidence\":0.9349748},{\"word\":\"remember\",\"start\":79.15619,\"end\":79.39545,\"confidence\":0.9949634},{\"word\":\"on\",\"start\":79.39545,\"end\":79.554955,\"confidence\":0.999759},{\"word\":\"your\",\"start\":79.554955,\"end\":79.63471,\"confidence\":0.99864084},{\"word\":\"own\",\"start\":79.63471,\"end\":79.71446,\"confidence\":0.9977324},{\"word\":\"absolutely\",\"start\":80.27274,\"end\":80.67152,\"confidence\":0.99206287},{\"word\":\"take\",\"start\":81.86783,\"end\":82.186844,\"confidence\":0.995337},{\"word\":\"power\",\"start\":82.186844,\"end\":82.58561,\"confidence\":0.998092},{\"word\":\"e\",\"start\":82.58561,\"end\":82.66537,\"confidence\":0.9916027},{\"word\":\"b\",\"start\":82.66537,\"end\":82.824875,\"confidence\":0.30798858},{\"word\":\"one\",\"start\":82.824875,\"end\":83.14389,\"confidence\":0.9905143},{\"word\":\"e\",\"start\":83.14389,\"end\":83.462906,\"confidence\":0.9853764},{\"word\":\"two\",\"start\":83.462906,\"end\":83.70217,\"confidence\":0.9943639},{\"word\":\"two\",\"start\":84.10094,\"end\":84.57947,\"confidence\":0.9592417},{\"word\":\"switches\",\"start\":84.57947,\"end\":84.738976,\"confidence\":0.8348126},{\"word\":\"to\",\"start\":84.738976,\"end\":84.89848,\"confidence\":0.9771891},{\"word\":\"us\",\"start\":84.89848,\"end\":85.2175,\"confidence\":0.62448585},{\"word\":\"o\",\"start\":85.2175,\"end\":85.61627,\"confidence\":0.8317143},{\"word\":\"f\",\"start\":85.61627,\"end\":85.77578,\"confidence\":0.557801},{\"word\":\"yeah\",\"start\":86.2543,\"end\":86.41381,\"confidence\":0.6751174},{\"word\":\"christina\",\"start\":86.73283,\"end\":87.21135,\"confidence\":0.9418222},{\"word\":\"jessica\",\"start\":87.865,\"end\":88.265,\"confidence\":0.99907625},{\"word\":\"have\",\"start\":88.265,\"end\":88.505,\"confidence\":0.9980051},{\"word\":\"enough\",\"start\":88.505,\"end\":88.745,\"confidence\":0.99988973},{\"word\":\"work\",\"start\":88.745,\"end\":89.245,\"confidence\":0.99902797},{\"word\":\"with\",\"start\":89.305,\"end\":89.465004,\"confidence\":0.9996891},{\"word\":\"their\",\"start\":89.465004,\"end\":89.625,\"confidence\":0.99195963},{\"word\":\"hands\",\"start\":89.625,\"end\":89.945,\"confidence\":0.99500436},{\"word\":\"and\",\"start\":89.945,\"end\":90.105,\"confidence\":0.99650675},{\"word\":\"feet\",\"start\":90.105,\"end\":90.265,\"confidence\":0.99773896},{\"word\":\"and\",\"start\":90.425,\"end\":90.505,\"confidence\":0.712047},{\"word\":\"their\",\"start\":90.505,\"end\":90.745,\"confidence\":0.9381194},{\"word\":\"brain\",\"start\":90.745,\"end\":91.245,\"confidence\":0.90095526},{\"word\":\"outside\",\"start\":91.305,\"end\":91.625,\"confidence\":0.99975485},{\"word\":\"that\",\"start\":91.625,\"end\":91.865,\"confidence\":0.9968437},{\"word\":\"it\",\"start\":91.865,\"end\":92.105,\"confidence\":0.99866056},{\"word\":\"really\",\"start\":92.105,\"end\":92.345,\"confidence\":0.9999037},{\"word\":\"helps\",\"start\":92.345,\"end\":92.585,\"confidence\":0.9914226},{\"word\":\"to\",\"start\":92.585,\"end\":92.745,\"confidence\":0.99578434},{\"word\":\"have\",\"start\":92.745,\"end\":92.985,\"confidence\":0.9978612},{\"word\":\"someone\",\"start\":92.985,\"end\":93.305,\"confidence\":0.99699485},{\"word\":\"like\",\"start\":93.385,\"end\":93.545,\"confidence\":0.9961845},{\"word\":\"stephanie\",\"start\":93.705,\"end\":94.025,\"confidence\":0.99350196},{\"word\":\"you\",\"start\":94.265,\"end\":94.505,\"confidence\":0.41569388},{\"word\":\"power\",\"start\":94.505,\"end\":94.825,\"confidence\":0.9367577},{\"word\":\"both\",\"start\":94.825,\"end\":95.145004,\"confidence\":0.9846039},{\"word\":\"off\",\"start\":95.145004,\"end\":95.305,\"confidence\":0.9451218},{\"word\":\"connector\",\"start\":111.46,\"end\":111.62,\"confidence\":0.60397935},{\"word\":\"your\",\"start\":111.62,\"end\":111.700005,\"confidence\":0.9747545},{\"word\":\"from\",\"start\":112.340004,\"end\":112.5,\"confidence\":0.9991009},{\"word\":\"your\",\"start\":112.5,\"end\":112.58,\"confidence\":0.99836177},{\"word\":\"dc\",\"start\":112.740005,\"end\":113.240005,\"confidence\":0.996846},{\"word\":\"and\",\"start\":113.46,\"end\":113.700005,\"confidence\":0.9974885},{\"word\":\"s\",\"start\":113.700005,\"end\":113.86,\"confidence\":0.9954068},{\"word\":\"the\",\"start\":113.86,\"end\":114.020004,\"confidence\":0.26444715},{\"word\":\"in\",\"start\":114.5,\"end\":114.66,\"confidence\":0.96549934},{\"word\":\"the\",\"start\":114.66,\"end\":114.82,\"confidence\":0.99744415},{\"word\":\"pouch\",\"start\":114.82,\"end\":115.060005,\"confidence\":0.9995932},{\"word\":\"kinda\",\"start\":118.51432,\"end\":118.832504,\"confidence\":0.5401386},{\"word\":\"the\",\"start\":118.832504,\"end\":118.99159,\"confidence\":0.4388202},{\"word\":\"interrupt\",\"start\":118.99159,\"end\":119.15069,\"confidence\":0.36033186},{\"word\":\"so\",\"start\":119.78705,\"end\":120.02569,\"confidence\":0.9887406},{\"word\":\"not\",\"start\":120.02569,\"end\":120.18478,\"confidence\":0.9947384},{\"word\":\"only\",\"start\":120.18478,\"end\":120.50296,\"confidence\":0.98287934},{\"word\":\"does\",\"start\":120.50296,\"end\":120.582504,\"confidence\":0.9591305},{\"word\":\"stephanie\",\"start\":120.74159,\"end\":121.218864,\"confidence\":0.9893464},{\"word\":\"thirty\",\"start\":142.34341,\"end\":142.66159,\"confidence\":0.9927779},{\"word\":\"eight\",\"start\":142.66159,\"end\":142.90022,\"confidence\":0.99224406},{\"word\":\"am\",\"start\":143.05933,\"end\":143.29796,\"confidence\":0.954241},{\"word\":\"central\",\"start\":143.29796,\"end\":143.53659,\"confidence\":0.9984043},{\"word\":\"time\",\"start\":143.53659,\"end\":143.61613,\"confidence\":0.9920243},{\"word\":\"a\",\"start\":143.77522,\"end\":143.85478,\"confidence\":0.96547014},{\"word\":\"little\",\"start\":143.85478,\"end\":144.17296,\"confidence\":0.9974809},{\"word\":\"ahead\",\"start\":144.17296,\"end\":144.2525,\"confidence\":0.9950151},{\"word\":\"of\",\"start\":144.2525,\"end\":144.49113,\"confidence\":0.95926064},{\"word\":\"schedule\",\"start\":144.49113,\"end\":144.80933,\"confidence\":0.9957034},{\"word\":\"about\",\"start\":144.80933,\"end\":145.1275,\"confidence\":0.99563015},{\"word\":\"twelve\",\"start\":145.1275,\"end\":145.36613,\"confidence\":0.99731904},{\"word\":\"minutes\",\"start\":145.36613,\"end\":145.60478,\"confidence\":0.9990018},{\"word\":\"but\",\"start\":145.76387,\"end\":146.26387,\"confidence\":0.9903672},{\"word\":\"that\",\"start\":146.655,\"end\":146.895,\"confidence\":0.9988097},{\"word\":\"gets\",\"start\":146.895,\"end\":147.05501,\"confidence\":0.98660916},{\"word\":\"us\",\"start\":147.05501,\"end\":147.455,\"confidence\":0.9987956},{\"word\":\"started\",\"start\":147.455,\"end\":147.77501,\"confidence\":0.9996424},{\"word\":\"on\",\"start\":147.77501,\"end\":148.015,\"confidence\":0.99905664},{\"word\":\"today's\",\"start\":148.015,\"end\":148.495,\"confidence\":0.99424577},{\"word\":\"historic\",\"start\":148.495,\"end\":148.815,\"confidence\":0.99748397},{\"word\":\"space\",\"start\":148.815,\"end\":149.05501,\"confidence\":0.9847166},{\"word\":\"walk\",\"start\":149.05501,\"end\":149.295,\"confidence\":0.5389857},{\"word\":\"morgan\",\"start\":154.58609,\"end\":154.90443,\"confidence\":0.937771},{\"word\":\"there\",\"start\":154.90443,\"end\":155.40443,\"confidence\":0.9944398},{\"word\":\"wishing\",\"start\":155.54114,\"end\":155.77989,\"confidence\":0.80184084},{\"word\":\"the\",\"start\":155.77989,\"end\":155.93907,\"confidence\":0.9284483},{\"word\":\"crew\",\"start\":155.93907,\"end\":156.09825,\"confidence\":0.9983191},{\"word\":\"luck\",\"start\":156.09825,\"end\":156.17784,\"confidence\":0.76250243},{\"word\":\"the\",\"start\":156.4166,\"end\":156.57578,\"confidence\":0.25588587},{\"word\":\"made\",\"start\":156.57578,\"end\":157.07578,\"confidence\":0.62067413},{\"word\":\"pouch\",\"start\":157.21248,\"end\":157.53082,\"confidence\":0.95132434},{\"word\":\"and\",\"start\":157.53082,\"end\":157.61041,\"confidence\":0.62313336},{\"word\":\"dc\",\"start\":157.69,\"end\":158.16753,\"confidence\":0.66087174},{\"word\":\"cover\",\"start\":158.16753,\"end\":158.48589,\"confidence\":0.97577643},{\"word\":\"closed\",\"start\":158.48589,\"end\":158.64505,\"confidence\":0.37828633},{\"word\":\"copy\",\"start\":162.7236,\"end\":162.9633,\"confidence\":0.99967265},{\"word\":\"e\",\"start\":163.04321,\"end\":163.36282,\"confidence\":0.7775096},{\"word\":\"two\",\"start\":163.36282,\"end\":163.52263,\"confidence\":0.67291963}]}]}]}}","language":"json","status":200},{"code":"{\n \"err_code\": \"INVALID_AUTH\",\n \"err_msg\": \"Invalid credentials.\",\n \"request_id\": \"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":401},{"code":"{\n \"err_code\": \"ASR_PAYMENT_REQUIRED\",\n \"err_msg\": \"Project does not have enough credits for an ASR request and does not have an overage agreement.\",\n \"request_id\": \"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":402},{"code":"{\n \"err_code\":\"Bad Request\",\n \t\"err_msg\":\"Content-type was application/json, but we could not process the JSON payload.\",\n \"request_id\":\"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":400},{"code":"{\"err_code\":\"INSUFFICIENT_PERMISSIONS\",\"err_msg\":\"Project does not have access to the requested model.\",\"request_id\":\"3cd19977-9b6d-4c37-9721-85ba0c6f7eb0\"}","language":"json","status":403,"name":"Forbidden"}]}},"title":"Transcribe & Analyze - Local file","icon":"","type":"endpoint","slug":"listen-file","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pre-recorded","category":"6466697af06669003714b160","createdAt":"2023-03-29T20:52:05.558Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"658d68189e7767007739e434","api":{"method":"post","url":"/listen","auth":"required","params":[{"name":"callback","type":"string","enumValues":"","default":"","desc":"Callback URL to provide if you would like your submitted audio to be processed asynchronously. <a href=\"/docs/callback\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9590"},{"name":"callback_method","type":"string","enumValues":"","default":"","desc":"Enable a callback method. Use put or post.","required":false,"in":"query","ref":"","_id":"65af16ae161c9c00701e47a7"},{"name":"channels","type":"int","enumValues":"","default":"","desc":"Number of independent audio channels contained in submitted audio. Only read when a value is provided for encoding. <a href=\"/docs/channels\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d58b710896000f0ab614"},{"name":"custom_intent","type":"string","enumValues":"","default":"","desc":"Optional. A custom intent you want the model to detect within your input audio if present. Submit up to 100.","required":false,"in":"query","ref":"","_id":"65c14e05328f8000421cdbe8"},{"name":"custom_topic","type":"string","enumValues":"","default":"","desc":"A custom topic you want the model to detect within your input audio if present. Submit up to one hundred topics.","required":false,"in":"query","ref":"","_id":"65bd427054196400211451c3"},{"name":"custom_intent_mode","type":"string","enumValues":"","default":"","desc":"When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in addition to those submitted using the `custom_intent` param. Default: `extended`","required":false,"in":"query","ref":"","_id":"65c14e05328f8000421cdbe7"},{"name":"custom_topic_mode","type":"enum","enumValues":"extended, strict","default":"","desc":"When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param. Default: `extended`","required":false,"in":"query","ref":"","_id":"65bd47718f872a006900d405"},{"name":"detect_language","type":"boolean","enumValues":"","default":"","desc":"Detect the language of the provided audio. Default: `false`. <a href=\"/docs/language-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959c"},{"name":"detect_entities","type":"boolean","enumValues":"","default":"","desc":"Entity Detection identifies and extracts key entities from content in submitted audio. Default: `false`","required":false,"in":"query","ref":"","_id":"65af15c8794ed9005edd5bf1"},{"name":"detect_topics","type":"boolean","enumValues":"","default":"","desc":"Identify and extract key topics. Default: `false`. <a href=\"/docs/topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958c"},{"name":"diarize","type":"boolean","enumValues":"","default":"","desc":"Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0. Default: `false`. <a href=\"/docs/diarization\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9597"},{"name":"dictation","type":"boolean","enumValues":"","default":"","desc":"Spoken dictation commands will be converted to their corresponding punctuation marks. e.g., comma to , Default: `false`","required":false,"in":"query","ref":"","_id":"64c192a3feb17800678de88e"},{"name":"diarize_version","type":"string","enumValues":"","default":"","desc":"Version of the diarization feature to use. Only used when the diarization feature is enabled (<code>diarize=true</code> is passed to the API). <a href=\"/docs/diarization#enable-feature\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9596"},{"name":"encoding","type":"string","enumValues":"","default":"","desc":"Expected encoding of the submitted audio. If this parameter is set, `sample_rate` must also be specified. <a href=\"/docs/encoding\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d58b710896000f0ab609"},{"name":"extra","type":"string","enumValues":"","default":"","desc":"Add any extra key-value pairs to the query string to customize the response. <a href=\"/docs/extra-metadata\">Learn More</a>","required":false,"in":"query","ref":"","_id":"657a3be9e03263006441c635"},{"name":"filler_words","type":"boolean","enumValues":"","default":"","desc":"Whether to include words like \"uh\" and \"um\" in transcription output. Default: `false`. <a href=\"/docs/filler-words\">Learn More</a>","required":false,"in":"query","ref":"","_id":"64c95c351af7500066f87c44"},{"name":"intents","type":"boolean","enumValues":"","default":"","desc":"Recognizes speaker intent throughout an entire transcript. Returns a list of text segments and the intents found within each segment. <a href=\"/docs/intent-recognition\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65c14e05328f8000421cdbe9"},{"name":"keywords","type":"string","enumValues":"","default":"","desc":"Uncommon proper nouns or other words to transcribe that are not a part of the model's vocabulary. Can send multiple instances in query string (for example, <code>keywords=snuffalupagus:10&keywords=systrom:5.5</code>). <a href=\"/docs/keywords\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958f"},{"name":"language","type":"enum","enumValues":"da, en, en-AU, en-GB, en-IN, en-NZ, en-US, es, es-419, fr, fr-CA, hi, hi-Latn, id, it, ja, ko, nl, pl, pt, pt-BR, pt-PT, ru, sv, tr, uk, zh-CN, zh-TW","default":"","desc":"The <a target='_blank\"' href=\"https://tools.ietf.org/html/bcp47\">BCP-47</a> language tag that hints at the primary spoken language. Default: `en`. <a href=\"/docs/language\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959d"},{"name":"measurements","type":"boolean","enumValues":"","default":"","desc":"Spoken measurements will be converted to their corresponding abbreviations. e.g., milligram to mg. Default: `false`","required":false,"in":"query","ref":"","_id":"64c192a3feb17800678de88f"},{"name":"model","type":"enum","enumValues":"nova-2-general, nova-2-meeting, nova-2-phonecall, nova-2-voicemail, nova-2-finance, nova-2-conversationalai, nova-2-video, nova-2-medical, nova-2-drivethru, nova-2-automotive, whisper, <custom_id>","default":"","desc":"AI model used to process submitted audio. Default: `base-general`. <a href=\"/docs/model\">Learn More</a>","required":false,"in":"query","ref":"","_id":"643863585841a9004b0f2ea4"},{"name":"multichannel","type":"boolean","enumValues":"","default":"","desc":"Transcribe each audio channel independently. Default: `false`. <a href=\"/docs/multichannel\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9595"},{"name":"numerals","type":"boolean","enumValues":"","default":"","desc":"Convert numbers from written format (e.g., one) to numerical format (e.g., 1). Default: `false`. <a href=\"/docs/numerals\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9593"},{"name":"paragraphs","type":"boolean","enumValues":"","default":"","desc":"Split audio into paragraphs. Default: `false`. <a href=\"/docs/paragraphs\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958e"},{"name":"profanity_filter","type":"boolean","enumValues":"","default":"","desc":"Remove profanity from the transcript. Default: `false`. <a href=\"/docs/profanity-filter\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959a"},{"name":"punctuate","type":"boolean","enumValues":"","default":"","desc":"Add punctuation and capitalization to the transcript. Default: `false`. <a href=\"/docs/punctuation\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c959b"},{"name":"redact","type":"enum","enumValues":"pci, numbers, true, ssn, false","default":"","desc":"Redact sensitive information, replacing redacted content with asterisks (*). Can send multiple instances in query string (for example, <code>redact=pci&redact=numbers</code>). Default: `false`. <a href=\"/docs/redaction\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9599"},{"name":"replace","type":"string","enumValues":"","default":"","desc":"Terms or phrases to search for in the submitted audio and replace. Can send multiple instances in query string (for example, <code>replace=this:that&replace=thisalso:thatalso</code>). <a href=\"/docs/find-and-replace\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9591"},{"name":"sample_rate","type":"int","enumValues":"","default":"","desc":"Sample rate of submitted audio. Required (and only read) when a value is provided for encoding. <a href=\"/docs/sample-rate\">Learn More</a>","required":false,"in":"query","ref":"","_id":"66c3d58b710896000f0ab5fa"},{"name":"search","type":"string","enumValues":"","default":"","desc":"Terms or phrases to search for in the submitted audio. Can send multiple instances in query string (for example, <code>search=speech&search=Friday</code>). <a href=\"/docs/search\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9592"},{"name":"sentiment","type":"boolean","enumValues":"","default":"","desc":"Recognizes the sentiment of the entire transcript and detects a shift in sentiment throughout the transcript. Returns a list of text segments and the sentiment found within each segment. <a href=\"/docs/sentiment-analysis\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd427054196400211451c6"},{"name":"smart_format","type":"boolean","enumValues":"","default":"","desc":"Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. Default: `false`. <a href=\"/docs/smart-format\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6449695b75044f0043ecf07d"},{"name":"summarize","type":"enum","enumValues":"v2","default":"","desc":"Summarize content. Default: `v2`. <a href=\"/docs/summarization\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958d"},{"name":"tag","type":"string","enumValues":"","default":"","desc":"Tag to associate with the request. <a href=\"/docs/tagging\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c9589"},{"name":"topics","type":"boolean","enumValues":"","default":"","desc":"Detects topics throughout an entire transcript. Returns a list of text segments and the topics found within each segment. <a href=\"/docs/topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd427054196400211451c4"},{"name":"utterances","type":"boolean","enumValues":"","default":"","desc":"Segment speech into meaningful units based on gaps in speech. Default: `false`. <a href=\"/docs/utterances\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958b"},{"name":"utt_split","type":"float","enumValues":"","default":"","desc":"Length of time in seconds used to split utterances. Default: `0.8`. <a href=\"/docs/utterance-split\">Learn More</a>","required":false,"in":"query","ref":"","_id":"6439b2a677652400216c958a"},{"name":"version","type":"enum","enumValues":"latest, <version_id>","default":"","desc":"Version of the model to use. Default: `latest`. <a href=\"/docs/version\">Learn More</a>","required":false,"in":"query","ref":"","_id":"643863585841a9004b0f2ea3"},{"name":"url","type":"string","enumValues":"","default":"https://dpgr.am/spacewalk.wav","desc":"Public URL of a file to transcribe. For pre-signed URLs, please see [our guide](/docs/using-aws-s3-presigned-urls-with-the-deepgram-api).","required":false,"in":"body","ref":"","_id":"658d68cf9c7630003b657af1"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"658d6793cbad49001c37e4f4"},{"name":"Accept","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"658d6793cbad49001c37e4f3"}],"apiSetting":"658d655ee44e4a00238ce370","examples":{"codes":[{"code":"curl --request POST \\\n --url https://api.deepgram.com/v1/listen \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Token YOUR_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\"url\": \"https://dpgr.am/spacewalk.wav\"}'","language":"curl"},{"code":"# Install the Deepgram Python SDK\n# pip install deepgram-sdk==3.*\n\nfrom deepgram import (\n DeepgramClient,\n PrerecordedOptions,\n)\n\nload_dotenv()\n\nAUDIO_URL = {\n \"url\": \"https://dpgr.am/spacewalk.wav\"\n}\n\n\ndef main():\n try:\n deepgram = DeepgramClient(\"DEEPGRAM_API_KEY\")\n options = PrerecordedOptions(\n model=\"nova-2\",\n smart_format=True,\n )\n response = deepgram.listen.rest.v(\"1\").transcribe_url(AUDIO_URL, options)\n return response\n\n except Exception as e:\n print(f\"Exception: {e}\")\n \n\nif __name__ == \"__main__\":\n main()\n","language":"python","name":"SDK"},{"code":"// Install the Deepgram JS SDK\n// npm install @deepgram/sdk\n\nconst { createClient } = require(\"@deepgram/sdk\");\n\nconst transcribeUrl = async () => {\n const deepgram = createClient(\"DEEPGRAM_API_KEY\");\n\n const { result, error } = await deepgram.listen.prerecorded.transcribeUrl(\n {\n url: \"https://dpgr.am/spacewalk.wav\",\n },\n {\n model: \"nova-2\",\n smart_format: true,\n }\n );\n\n if (error) throw error;\n if (!error) return result;\n};\n\ntranscribeUrl();","language":"javascript","name":"SDK"},{"code":"// Install the Deepgram Go SDK\n// go get github.com/deepgram/deepgram-go-sdk\n\npackage main\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\n\tprettyjson \"github.com/hokaccha/go-prettyjson\"\n\n\tapi \"github.com/deepgram/deepgram-go-sdk/pkg/api/listen/v1/rest\"\n\tinterfaces \"github.com/deepgram/deepgram-go-sdk/pkg/client/interfaces\"\n\tclient \"github.com/deepgram/deepgram-go-sdk/pkg/client/listen\"\n)\n\nconst (\n\turl string = \"https://dpgr.am/spacewalk.wav\"\n)\n\nfunc main() {\n\tclient.InitWithDefault()\n\n\tctx := context.Background()\n\n\toptions := interfaces.PreRecordedTranscriptionOptions{\n\t\tModel: \"nova-2\",\n\t\tSmartFormat: true,\n\t}\n\t\n // NOTE: you can set your API KEY in your bash profile by typing the following line in your shell:\n\t// export DEEPGRAM_API_KEY = \"YOUR_DEEPGRAM_API_KEY\"\n\tc := client.NewWithDefaults()\n\tdg := api.New(c)\n\n\tres, err := dg.FromURL(ctx, url, options)\n\tif err != nil {\n\t\tfmt.Printf(\"FromURL failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tdata, err := json.Marshal(res)\n\tif err != nil {\n\t\tfmt.Printf(\"json.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tprettyJson, err := prettyjson.Format(data)\n\tif err != nil {\n\t\tfmt.Printf(\"prettyjson.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\tfmt.Printf(\"\\n\\nResult:\\n%s\\n\\n\", prettyJson)\n}\n","language":"go","name":"SDK"},{"code":"// Install the Deepgram .NET SDK\n// dotnet add package Deepgram\n\nusing Deepgram.Models.Listen.v1.REST;\n\n// Initialize Library with default logging\nLibrary.Initialize();\n\n// create a ListenRESTClient directly (without using the factory method) with a API Key\n// set using the \"DEEPGRAM_API_KEY\" environment variable\nvar deepgramClient = new ListenRESTClient();\n\nvar response = await deepgramClient.TranscribeUrl(\n new UrlSource(\"https://dpgr.am/bueller.wav\"),\n new PreRecordedSchema()\n {\n Model = \"nova-2\",\n SmartFormat=true,\n });\n\nConsole.WriteLine(response);\nConsole.ReadKey();\n\n// Teardown Library\nLibrary.Terminate();","language":"csharp","name":"SDK"},{"code":"import http.client\nimport json\n\n# Create the connection\nconn = http.client.HTTPSConnection(\"api.deepgram.com\")\n\n# Define the payload for the HTTP request\npayload = json.dumps({\"url\": \"https://dpgr.am/spacewalk.wav\"})\n\n# Define the headers for the HTTP request\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Token DEEPGRAM_API_KEY'\n}\n\n# Make the HTTP request\nconn.request(\"POST\", \"/v1/listen\", payload, headers)\n\n# Get the response from the HTTP request\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))","language":"python","name":"HTTP client"},{"code":"import requests\n\n# Define the URL for the Deepgram API endpoint\nurl = \"https://api.deepgram.com/v1/listen\"\n\n# Define the headers for the HTTP request\nheaders = {\n \"Accept\": \"application/json\",\n \"Authorization\": \"Token DEEPGRAM_API_KEY\",\n \"Content-Type\": \"application/json\"\n}\n# Define the data for the HTTP request\ndata = {\"url\": \"https://dpgr.am/spacewalk.wav\"}\n\n# Make the HTTP request\nresponse = requests.post(url, headers=headers, json=data)\n\nprint(response.json())","language":"python","name":"Requests"},{"code":"const url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioUrl = \"https://dpgr.am/spacewalk.wav\";\n\n// Define the request data object\nconst data = {\n url: audioUrl,\n};\n\n// Define the request headers object\nconst headers = {\n Accept: \"application/json\",\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n};\n\n// Make the POST request using fetch API\nfetch(url, {\n method: \"POST\",\n headers: headers, // Pass the headers object\n body: JSON.stringify(data), // Convert data object to JSON string\n})\n .then((response) => response.json()) // Parse the JSON response\n .then((data) => {\n console.dir(data.results, { depth: null }); // Log response data\n })\n .catch((error) => {\n console.error(\"Error:\", error); // Handle errors\n });\n","language":"javascript","name":"fetch"},{"code":"const axios = require(\"axios\");\n\nconst url = \"https://api.deepgram.com/v1/listen\";\nconst apiKey = \"DEEPGRAM_API_KEY\"; // Replace with your actual API key\nconst audioUrl = \"https://dpgr.am/spacewalk.wav\";\n\n// Define request data\nconst requestData = {\n url: audioUrl,\n};\n\n// Define request headers\nconst headers = {\n Accept: \"application/json\",\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n};\n\n// Make the POST request using axios\naxios\n .post(url, requestData, { headers: headers })\n .then((response) => {\n console.dir(response.data.results, { depth: null }); // Handle response data\n })\n .catch((error) => {\n console.error(\"Error:\", error); // Handle errors\n });\n","language":"javascript","name":"axios"},{"code":"package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\n\turl := \"https://api.deepgram.com/v1/listen\"\n\tmethod := \"POST\"\n\n\tpayload := strings.NewReader(`{\"url\":\"https://dpgr.am/spacewalk.wav\"}`)\n\n\tclient := &http.Client{}\n\treq, err := http.NewRequest(method, url, payload)\n\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Token DEEPGRAM_API_KEY\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tfmt.Println(string(body))\n}\n","language":"go","name":"net/http"},{"code":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main(string[] args)\n {\n string apiKey = \"DEEPGRAM_API_KEY\";\n string url = \"https://api.deepgram.com/v1/listen\";\n string audioUrl = \"https://dpgr.am/spacewalk.wav\";\n\n using (HttpClient client = new HttpClient())\n {\n client.DefaultRequestHeaders.Add(\"Accept\", \"application/json\");\n client.DefaultRequestHeaders.Add(\"Authorization\", \"Token \" + apiKey);\n \n var requestBody = new { url = audioUrl };\n var json = Newtonsoft.Json.JsonConvert.SerializeObject(requestBody);\n var content = new StringContent(json, System.Text.Encoding.UTF8, \"application/json\");\n\n HttpResponseMessage response = await client.PostAsync(url, content);\n\n if (response.IsSuccessStatusCode)\n {\n string responseContent = await response.Content.ReadAsStringAsync();\n Console.WriteLine(responseContent);\n }\n else\n {\n Console.WriteLine($\"Error: {response.StatusCode}\");\n }\n }\n }\n}\n","language":"csharp","name":"HTTPCLIENT"},{"code":"require 'uri'\nrequire 'net/http'\nrequire 'json'\n\n# Parse the URI for the Deepgram API endpoint\nuri = URI.parse('https://api.deepgram.com/v1/listen')\n\n# Create a new HTTP POST request\nrequest = Net::HTTP::Post.new(uri)\n\n# Set the headers\nrequest.content_type = 'application/json'\nrequest['Accept'] = 'application/json'\nrequest['Authorization'] = 'Token DEEPGRAM_API_KEY'\n\n# Set the request body with a JSON payload containing the UR\nrequest.body = JSON.dump({\n 'url' => 'https://dpgr.am/spacewalk.wav'\n })\n# Send the HTTP request and store the response\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\n# Output the response body\nputs response.body\n","language":"ruby","name":"net/http"},{"code":"#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <curl/curl.h>\n\nint main(void) {\n CURL *curl;\n CURLcode res;\n\n // Initialize libcurl\n curl = curl_easy_init();\n if(curl) {\n // Set the request headers\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Accept: application/json\");\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\");\n headers = curl_slist_append(headers, \"Content-Type: application/json\");\n\n // Set the request URL\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/listen\");\n // Set the request headers\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n\n // Set the request data\n const char *json_data = \"{\\\"url\\\": \\\"https://dpgr.am/spacewalk.wav\\\"}\";\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json_data);\n\n // Perform the request\n res = curl_easy_perform(curl);\n // Check for errors\n if(res != CURLE_OK)\n fprintf(stderr, \"curl_easy_perform() failed: %s\\n\",\n curl_easy_strerror(res));\n\n // Cleanup\n curl_slist_free_all(headers);\n curl_easy_cleanup(curl);\n }\n return 0;\n}\n","language":"c","name":"libcurl"},{"code":"import okhttp3.*;\n\nimport java.io.IOException;\n\npublic class Main {\n public static void main(String[] args) throws IOException {\n // Replace \"YOUR_API_KEY\" with your actual API key\n String apiKey = \"DEEPGRAM_API_KEY\";\n String url = \"https://api.deepgram.com/v1/listen\";\n String audioUrl = \"https://dpgr.am/spacewalk.wav\";\n\n // Create OkHttpClient instance\n OkHttpClient client = new OkHttpClient();\n\n // Create JSON request body\n MediaType mediaType = MediaType.parse(\"application/json\");\n String json = \"{\\\"url\\\": \\\"\" + audioUrl + \"\\\"}\";\n RequestBody body = RequestBody.create(json, mediaType);\n\n // Create HTTP request\n Request request = new Request.Builder()\n .url(url)\n .post(body)\n .addHeader(\"Accept\", \"application/json\")\n .addHeader(\"Authorization\", \"Token \" + apiKey)\n .addHeader(\"Content-Type\", \"application/json\")\n .build();\n\n // Execute the request and get the response\n Response response = client.newCall(request).execute();\n\n // Print the response body\n if (response.isSuccessful()) {\n System.out.println(response.body().string());\n } else {\n System.out.println(\"Request failed: \" + response.code() + \" - \" + response.message());\n }\n\n // Close the response\n response.close();\n }\n}\n","language":"java","name":"okhttp3"},{"code":"import Foundation\n\n// Define the URL for the Deepgram API endpoint\nlet url = URL(string: \"https://api.deepgram.com/v1/listen\")!\n\n// Define the request body\nlet requestBody = [\"url\": \"https://dpgr.am/spacewalk.wav\"]\nguard let httpBody = try? JSONSerialization.data(withJSONObject: requestBody) else {\n print(\"Error: Unable to serialize request body\")\n exit(1)\n}\n\n// Define the request headers\nvar request = URLRequest(url: url)\nrequest.httpMethod = \"POST\"\nrequest.setValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.setValue(\"application/json\", forHTTPHeaderField: \"Accept\")\nrequest.setValue(\"Token DEEPGRAM_API_KEY\", forHTTPHeaderField: \"Authorization\") // Replace YOUR_DEEPGRAM_API_KEY with your actual API key\nrequest.httpBody = httpBody\n\n// Perform the HTTP request\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in\n guard let data = data, let httpResponse = response as? HTTPURLResponse, error == nil else {\n print(\"Error: \\(error?.localizedDescription ?? \"Unknown error\")\")\n return\n }\n\n // Check if the HTTP request was successful (status code 200)\n guard httpResponse.statusCode == 200 else {\n print(\"HTTP request failed with status code \\(httpResponse.statusCode)\")\n return\n }\n\n // Parse and print the response body\n if let responseBody = String(data: data, encoding: .utf8) {\n print(\"Response: \\(responseBody)\")\n } else {\n print(\"Error: Unable to parse response body\")\n }\n}\n\ntask.resume()\n\n// Keep the program running until the HTTP request completes\nRunLoop.main.run()\n","language":"swift","name":"URLSession"},{"code":"<?php\n\n// API endpoint URL\n$url = \"https://api.deepgram.com/v1/listen\";\n\n// API key\n$apiKey = \"DEEPGRAM_API_KEY\";\n\n// Audio file URL\n$audioUrl = \"https://dpgr.am/spacewalk.wav\";\n\n// Request body data\n$data = array(\n \"url\" => $audioUrl\n);\n\n// Convert data to JSON format\n$jsonData = json_encode($data);\n\n// cURL initialization\n$ch = curl_init();\n\n// Set cURL options\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n 'Accept: application/json',\n 'Authorization: Token ' . $apiKey,\n 'Content-Type: application/json'\n));\n\n// Execute cURL request\n$response = curl_exec($ch);\n\n// Check for errors\nif ($response === false) {\n echo 'cURL error: ' . curl_error($ch);\n} else {\n // Print the response\n echo $response;\n}\n\n// Close cURL session\ncurl_close($ch);\n\n?>\n","language":"php","name":"cURL"},{"code":"#include <iostream>\n#include <curl/curl.h>\n\nint main() {\n // Initialize libcurl\n curl_global_init(CURL_GLOBAL_ALL);\n \n // Create a CURL handle\n CURL *curl = curl_easy_init();\n if (curl) {\n // Set the request URL\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/listen\");\n \n // Set the request headers\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Accept: application/json\");\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\");\n headers = curl_slist_append(headers, \"Content-Type: application/json\");\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n \n // Set the request data\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, \"{\\\"url\\\": \\\"https://dpgr.am/spacewalk.wav\\\"}\");\n \n // Perform the request\n CURLcode res = curl_easy_perform(curl);\n \n // Check for errors\n if (res != CURLE_OK) {\n std::cerr << \"curl_easy_perform() failed: \" << curl_easy_strerror(res) << std::endl;\n }\n \n // Cleanup\n curl_easy_cleanup(curl);\n curl_slist_free_all(headers);\n } else {\n std::cerr << \"Failed to initialize libcurl\" << std::endl;\n }\n \n // Cleanup libcurl\n curl_global_cleanup();\n \n return 0;\n}\n","language":"cplusplus","name":"libcurl"},{"code":" Code example coming soon","language":"clojure","name":"Coming Soon"},{"code":" Code example coming soon","language":"objectivec","name":"Coming Soon"},{"code":" Code example coming soon","language":"ocaml","name":"Coming Soon"},{"code":" Code example coming soon","language":"powershell","name":"Coming Soon"},{"code":" Code example coming soon","language":"r","name":"Coming Soon"},{"code":" Code example coming soon","language":"kotlin","name":"Coming Soon"},{"code":"require 'httparty'\n\n# Define the URL for the Deepgram API endpoint\nurl = 'https://api.deepgram.com/v1/listen'\n\n# Define headers\nheaders = {\n 'Accept' => 'application/json',\n 'Authorization' => 'Token DEEPGRAM_API_KEY',\n 'Content-Type' => 'application/json'\n}\n\n# Define the request body in JSON format\nbody = {\n url: 'https://dpgr.am/spacewalk.wav'\n}.to_json\n\n# Make a POST request to the Deepgram API endpoint using HTTParty\nresponse = HTTParty.post(url, headers: headers, body: body)\n\n# Output the response\nputs response.body","language":"ruby","name":"httparty"}]},"results":{"codes":[{"code":"{\"metadata\":{\"transaction_key\":\"deprecated\",\"request_id\":\"4399e2a5-2b29-4e1e-9456-79043cc88d0a\",\"sha256\":\"362c1aae4da8c8952bd29fdd5eda25f7c3e92b040b5c31f741a0e0df7c061608\",\"created\":\"2023-05-30T14:17:36.953Z\",\"duration\":169.802,\"channels\":1,\"models\":[\"96a295ec-6336-43d5-b1cb-1e48b5e6d9a4\"],\"model_info\":{\"96a295ec-6336-43d5-b1cb-1e48b5e6d9a4\":{\"name\":\"general\",\"version\":\"2023-02-22.3\",\"arch\":\"base\"}}},\"results\":{\"channels\":[{\"alternatives\":[{\"transcript\":\"and jessica christina we are so proud you you're gonna do great today we'll be waiting for you here in a couple hours when you get home i'm gonna hand you over to stephanie now have a great great eva drew thank you so much and our pleasure working with you this morning and i'm working on getting that easy hatch open and i can report it's opened and s thank drew thank you so much on your dc take your power switches to bat stagger switch throws and expect a warning tone final steps where they begin the space copy check display switch functional tracy how important is this the the guiding it the isn't like seems like a lot to remember on your own absolutely take power e b one e two two switches to us o f yeah christina jessica have enough work with their hands and feet and their brain outside that it really helps to have someone like stephanie you power both off connector your from your dc and s the in the pouch kinda the interrupt so not only does stephanie thirty eight am central time a little ahead of schedule about twelve minutes but that gets us started on today's historic space walk morgan there wishing the crew luck the made pouch and dc cover closed copy e two\",\"confidence\":0.97326756,\"words\":[{\"word\":\"and\",\"start\":3.067842,\"end\":3.567842,\"confidence\":0.9807649},{\"word\":\"jessica\",\"start\":4.8208942,\"end\":5.2193155,\"confidence\":0.9766418},{\"word\":\"christina\",\"start\":5.538052,\"end\":5.777105,\"confidence\":0.9684238},{\"word\":\"we\",\"start\":6.095842,\"end\":6.4145784,\"confidence\":0.9931241},{\"word\":\"are\",\"start\":6.4145784,\"end\":6.892684,\"confidence\":0.9892484},{\"word\":\"so\",\"start\":6.892684,\"end\":7.1317363,\"confidence\":0.98863983},{\"word\":\"proud\",\"start\":7.1317363,\"end\":7.4504733,\"confidence\":0.99803776},{\"word\":\"you\",\"start\":7.4504733,\"end\":7.585,\"confidence\":0.94981164},{\"word\":\"you're\",\"start\":8.662,\"end\":8.901333,\"confidence\":0.9753204},{\"word\":\"gonna\",\"start\":8.901333,\"end\":9.140667,\"confidence\":0.96902674},{\"word\":\"do\",\"start\":9.140667,\"end\":9.300222,\"confidence\":0.97186357},{\"word\":\"great\",\"start\":9.300222,\"end\":9.619333,\"confidence\":0.9995757},{\"word\":\"today\",\"start\":9.619333,\"end\":9.699111,\"confidence\":0.9982907},{\"word\":\"we'll\",\"start\":9.938444,\"end\":10.098,\"confidence\":0.9700654},{\"word\":\"be\",\"start\":10.098,\"end\":10.257555,\"confidence\":0.99841106},{\"word\":\"waiting\",\"start\":10.257555,\"end\":10.496889,\"confidence\":0.99966013},{\"word\":\"for\",\"start\":10.496889,\"end\":10.656445,\"confidence\":0.9985917},{\"word\":\"you\",\"start\":10.656445,\"end\":10.816,\"confidence\":0.99760073},{\"word\":\"here\",\"start\":10.816,\"end\":10.975555,\"confidence\":0.9821878},{\"word\":\"in\",\"start\":10.975555,\"end\":11.055333,\"confidence\":0.98402536},{\"word\":\"a\",\"start\":11.055333,\"end\":11.214889,\"confidence\":0.99080414},{\"word\":\"couple\",\"start\":11.214889,\"end\":11.454222,\"confidence\":0.99982774},{\"word\":\"hours\",\"start\":11.454222,\"end\":11.693556,\"confidence\":0.9998036},{\"word\":\"when\",\"start\":11.693556,\"end\":11.773334,\"confidence\":0.9985682},{\"word\":\"you\",\"start\":11.773334,\"end\":11.932889,\"confidence\":0.99776137},{\"word\":\"get\",\"start\":11.932889,\"end\":12.092444,\"confidence\":0.9987956},{\"word\":\"home\",\"start\":12.092444,\"end\":12.252,\"confidence\":0.99989545},{\"word\":\"i'm\",\"start\":12.810444,\"end\":12.969999,\"confidence\":0.9968612},{\"word\":\"gonna\",\"start\":12.969999,\"end\":13.209333,\"confidence\":0.98595315},{\"word\":\"hand\",\"start\":13.209333,\"end\":13.289111,\"confidence\":0.9997478},{\"word\":\"you\",\"start\":13.289111,\"end\":13.448667,\"confidence\":0.99819785},{\"word\":\"over\",\"start\":13.448667,\"end\":13.528444,\"confidence\":0.9993493},{\"word\":\"to\",\"start\":13.528444,\"end\":13.688,\"confidence\":0.99777526},{\"word\":\"stephanie\",\"start\":13.847555,\"end\":14.246445,\"confidence\":0.9936746},{\"word\":\"now\",\"start\":14.246445,\"end\":14.326222,\"confidence\":0.98286617},{\"word\":\"have\",\"start\":15.860001,\"end\":16.02,\"confidence\":0.9736103},{\"word\":\"a\",\"start\":16.02,\"end\":16.18,\"confidence\":0.9868292},{\"word\":\"great\",\"start\":16.18,\"end\":16.58,\"confidence\":0.97828484},{\"word\":\"great\",\"start\":16.58,\"end\":16.82,\"confidence\":0.9986426},{\"word\":\"eva\",\"start\":16.900002,\"end\":17.380001,\"confidence\":0.81174904},{\"word\":\"drew\",\"start\":17.7,\"end\":17.86,\"confidence\":0.96023065},{\"word\":\"thank\",\"start\":18.02,\"end\":18.18,\"confidence\":0.99756265},{\"word\":\"you\",\"start\":18.18,\"end\":18.42,\"confidence\":0.9986058},{\"word\":\"so\",\"start\":18.42,\"end\":18.58,\"confidence\":0.99923587},{\"word\":\"much\",\"start\":18.58,\"end\":18.82,\"confidence\":0.9993931},{\"word\":\"and\",\"start\":19.300001,\"end\":19.460001,\"confidence\":0.8400723},{\"word\":\"our\",\"start\":19.460001,\"end\":19.7,\"confidence\":0.97326756},{\"word\":\"pleasure\",\"start\":19.7,\"end\":19.94,\"confidence\":0.9969959},{\"word\":\"working\",\"start\":19.94,\"end\":20.18,\"confidence\":0.9986186},{\"word\":\"with\",\"start\":20.18,\"end\":20.34,\"confidence\":0.99988437},{\"word\":\"you\",\"start\":20.34,\"end\":20.5,\"confidence\":0.99919075},{\"word\":\"this\",\"start\":20.5,\"end\":20.66,\"confidence\":0.99971086},{\"word\":\"morning\",\"start\":20.66,\"end\":21.060001,\"confidence\":0.99977344},{\"word\":\"and\",\"start\":21.060001,\"end\":21.460001,\"confidence\":0.99385434},{\"word\":\"i'm\",\"start\":21.460001,\"end\":21.54,\"confidence\":0.6949018},{\"word\":\"working\",\"start\":21.54,\"end\":21.78,\"confidence\":0.9936865},{\"word\":\"on\",\"start\":21.78,\"end\":21.94,\"confidence\":0.9969817},{\"word\":\"getting\",\"start\":21.94,\"end\":22.18,\"confidence\":0.9988746},{\"word\":\"that\",\"start\":22.18,\"end\":22.26,\"confidence\":0.94096375},{\"word\":\"easy\",\"start\":22.34,\"end\":22.66,\"confidence\":0.4179583},{\"word\":\"hatch\",\"start\":22.66,\"end\":22.900002,\"confidence\":0.80127984},{\"word\":\"open\",\"start\":22.900002,\"end\":23.14,\"confidence\":0.97084236},{\"word\":\"and\",\"start\":23.714266,\"end\":23.873285,\"confidence\":0.986055},{\"word\":\"i\",\"start\":23.952795,\"end\":24.032305,\"confidence\":0.8785544},{\"word\":\"can\",\"start\":24.032305,\"end\":24.350344,\"confidence\":0.78802234},{\"word\":\"report\",\"start\":24.350344,\"end\":24.850344,\"confidence\":0.7833075},{\"word\":\"it's\",\"start\":25.702011,\"end\":25.94054,\"confidence\":0.43321013},{\"word\":\"opened\",\"start\":25.94054,\"end\":26.25858,\"confidence\":0.939075},{\"word\":\"and\",\"start\":26.25858,\"end\":26.576618,\"confidence\":0.96032727},{\"word\":\"s\",\"start\":26.576618,\"end\":26.894657,\"confidence\":0.9379913},{\"word\":\"thank\",\"start\":28.961912,\"end\":29.120934,\"confidence\":0.9708335},{\"word\":\"drew\",\"start\":29.438972,\"end\":29.597992,\"confidence\":0.9918337},{\"word\":\"thank\",\"start\":30.07505,\"end\":30.23407,\"confidence\":0.9985739},{\"word\":\"you\",\"start\":30.23407,\"end\":30.472599,\"confidence\":0.9980198},{\"word\":\"so\",\"start\":30.472599,\"end\":30.631618,\"confidence\":0.99978584},{\"word\":\"much\",\"start\":30.631618,\"end\":30.870148,\"confidence\":0.9996094},{\"word\":\"on\",\"start\":38.223537,\"end\":38.383133,\"confidence\":0.928422},{\"word\":\"your\",\"start\":38.383133,\"end\":38.46293,\"confidence\":0.9850849},{\"word\":\"dc\",\"start\":38.622528,\"end\":39.122528,\"confidence\":0.5699869},{\"word\":\"take\",\"start\":39.83451,\"end\":39.99412,\"confidence\":0.99883646},{\"word\":\"your\",\"start\":39.99412,\"end\":40.233532,\"confidence\":0.9995505},{\"word\":\"power\",\"start\":40.233532,\"end\":40.712357,\"confidence\":0.99378115},{\"word\":\"switches\",\"start\":40.712357,\"end\":40.871964,\"confidence\":0.99915934},{\"word\":\"to\",\"start\":40.871964,\"end\":41.111374,\"confidence\":0.99873084},{\"word\":\"bat\",\"start\":41.111374,\"end\":41.27098,\"confidence\":0.7712309},{\"word\":\"stagger\",\"start\":41.749805,\"end\":42.148827,\"confidence\":0.98734725},{\"word\":\"switch\",\"start\":42.148827,\"end\":42.388237,\"confidence\":0.936786},{\"word\":\"throws\",\"start\":42.388237,\"end\":42.627647,\"confidence\":0.97849435},{\"word\":\"and\",\"start\":42.627647,\"end\":42.946865,\"confidence\":0.99815005},{\"word\":\"expect\",\"start\":42.946865,\"end\":43.106472,\"confidence\":0.99575573},{\"word\":\"a\",\"start\":43.106472,\"end\":43.26608,\"confidence\":0.9927196},{\"word\":\"warning\",\"start\":43.26608,\"end\":43.505493,\"confidence\":0.9998263},{\"word\":\"tone\",\"start\":43.505493,\"end\":43.744904,\"confidence\":0.99915254},{\"word\":\"final\",\"start\":64.42,\"end\":64.82,\"confidence\":0.99228233},{\"word\":\"steps\",\"start\":64.82,\"end\":65.06,\"confidence\":0.984963},{\"word\":\"where\",\"start\":65.06,\"end\":65.22,\"confidence\":0.49309498},{\"word\":\"they\",\"start\":65.22,\"end\":65.46,\"confidence\":0.96069825},{\"word\":\"begin\",\"start\":65.46,\"end\":65.54,\"confidence\":0.9870433},{\"word\":\"the\",\"start\":65.54,\"end\":65.7,\"confidence\":0.9080708},{\"word\":\"space\",\"start\":65.7,\"end\":65.86,\"confidence\":0.9228741},{\"word\":\"copy\",\"start\":66.1,\"end\":66.26,\"confidence\":0.8863323},{\"word\":\"check\",\"start\":66.659996,\"end\":67.06,\"confidence\":0.99407756},{\"word\":\"display\",\"start\":67.06,\"end\":67.3,\"confidence\":0.9952095},{\"word\":\"switch\",\"start\":67.3,\"end\":67.78,\"confidence\":0.9902741},{\"word\":\"functional\",\"start\":67.78,\"end\":68.1,\"confidence\":0.98246896},{\"word\":\"tracy\",\"start\":74.18979,\"end\":74.42948,\"confidence\":0.9510427},{\"word\":\"how\",\"start\":74.58928,\"end\":74.90887,\"confidence\":0.9951479},{\"word\":\"important\",\"start\":74.90887,\"end\":75.06866,\"confidence\":0.9719207},{\"word\":\"is\",\"start\":75.06866,\"end\":75.228455,\"confidence\":0.9141554},{\"word\":\"this\",\"start\":75.228455,\"end\":75.46814,\"confidence\":0.7431963},{\"word\":\"the\",\"start\":75.46814,\"end\":75.96814,\"confidence\":0.45991337},{\"word\":\"the\",\"start\":76.74649,\"end\":76.98618,\"confidence\":0.38744238},{\"word\":\"guiding\",\"start\":76.98618,\"end\":77.225876,\"confidence\":0.6274184},{\"word\":\"it\",\"start\":77.225876,\"end\":77.385666,\"confidence\":0.33466855},{\"word\":\"the\",\"start\":77.385666,\"end\":77.54546,\"confidence\":0.33121714},{\"word\":\"isn't\",\"start\":77.54546,\"end\":77.92,\"confidence\":0.50690776},{\"word\":\"like\",\"start\":78.199135,\"end\":78.35864,\"confidence\":0.34808892},{\"word\":\"seems\",\"start\":78.35864,\"end\":78.51815,\"confidence\":0.9660647},{\"word\":\"like\",\"start\":78.51815,\"end\":78.677666,\"confidence\":0.99579394},{\"word\":\"a\",\"start\":78.677666,\"end\":78.83717,\"confidence\":0.90933007},{\"word\":\"lot\",\"start\":78.83717,\"end\":78.99668,\"confidence\":0.3617743},{\"word\":\"to\",\"start\":78.99668,\"end\":79.15619,\"confidence\":0.9349748},{\"word\":\"remember\",\"start\":79.15619,\"end\":79.39545,\"confidence\":0.9949634},{\"word\":\"on\",\"start\":79.39545,\"end\":79.554955,\"confidence\":0.999759},{\"word\":\"your\",\"start\":79.554955,\"end\":79.63471,\"confidence\":0.99864084},{\"word\":\"own\",\"start\":79.63471,\"end\":79.71446,\"confidence\":0.9977324},{\"word\":\"absolutely\",\"start\":80.27274,\"end\":80.67152,\"confidence\":0.99206287},{\"word\":\"take\",\"start\":81.86783,\"end\":82.186844,\"confidence\":0.995337},{\"word\":\"power\",\"start\":82.186844,\"end\":82.58561,\"confidence\":0.998092},{\"word\":\"e\",\"start\":82.58561,\"end\":82.66537,\"confidence\":0.9916027},{\"word\":\"b\",\"start\":82.66537,\"end\":82.824875,\"confidence\":0.30798858},{\"word\":\"one\",\"start\":82.824875,\"end\":83.14389,\"confidence\":0.9905143},{\"word\":\"e\",\"start\":83.14389,\"end\":83.462906,\"confidence\":0.9853764},{\"word\":\"two\",\"start\":83.462906,\"end\":83.70217,\"confidence\":0.9943639},{\"word\":\"two\",\"start\":84.10094,\"end\":84.57947,\"confidence\":0.9592417},{\"word\":\"switches\",\"start\":84.57947,\"end\":84.738976,\"confidence\":0.8348126},{\"word\":\"to\",\"start\":84.738976,\"end\":84.89848,\"confidence\":0.9771891},{\"word\":\"us\",\"start\":84.89848,\"end\":85.2175,\"confidence\":0.62448585},{\"word\":\"o\",\"start\":85.2175,\"end\":85.61627,\"confidence\":0.8317143},{\"word\":\"f\",\"start\":85.61627,\"end\":85.77578,\"confidence\":0.557801},{\"word\":\"yeah\",\"start\":86.2543,\"end\":86.41381,\"confidence\":0.6751174},{\"word\":\"christina\",\"start\":86.73283,\"end\":87.21135,\"confidence\":0.9418222},{\"word\":\"jessica\",\"start\":87.865,\"end\":88.265,\"confidence\":0.99907625},{\"word\":\"have\",\"start\":88.265,\"end\":88.505,\"confidence\":0.9980051},{\"word\":\"enough\",\"start\":88.505,\"end\":88.745,\"confidence\":0.99988973},{\"word\":\"work\",\"start\":88.745,\"end\":89.245,\"confidence\":0.99902797},{\"word\":\"with\",\"start\":89.305,\"end\":89.465004,\"confidence\":0.9996891},{\"word\":\"their\",\"start\":89.465004,\"end\":89.625,\"confidence\":0.99195963},{\"word\":\"hands\",\"start\":89.625,\"end\":89.945,\"confidence\":0.99500436},{\"word\":\"and\",\"start\":89.945,\"end\":90.105,\"confidence\":0.99650675},{\"word\":\"feet\",\"start\":90.105,\"end\":90.265,\"confidence\":0.99773896},{\"word\":\"and\",\"start\":90.425,\"end\":90.505,\"confidence\":0.712047},{\"word\":\"their\",\"start\":90.505,\"end\":90.745,\"confidence\":0.9381194},{\"word\":\"brain\",\"start\":90.745,\"end\":91.245,\"confidence\":0.90095526},{\"word\":\"outside\",\"start\":91.305,\"end\":91.625,\"confidence\":0.99975485},{\"word\":\"that\",\"start\":91.625,\"end\":91.865,\"confidence\":0.9968437},{\"word\":\"it\",\"start\":91.865,\"end\":92.105,\"confidence\":0.99866056},{\"word\":\"really\",\"start\":92.105,\"end\":92.345,\"confidence\":0.9999037},{\"word\":\"helps\",\"start\":92.345,\"end\":92.585,\"confidence\":0.9914226},{\"word\":\"to\",\"start\":92.585,\"end\":92.745,\"confidence\":0.99578434},{\"word\":\"have\",\"start\":92.745,\"end\":92.985,\"confidence\":0.9978612},{\"word\":\"someone\",\"start\":92.985,\"end\":93.305,\"confidence\":0.99699485},{\"word\":\"like\",\"start\":93.385,\"end\":93.545,\"confidence\":0.9961845},{\"word\":\"stephanie\",\"start\":93.705,\"end\":94.025,\"confidence\":0.99350196},{\"word\":\"you\",\"start\":94.265,\"end\":94.505,\"confidence\":0.41569388},{\"word\":\"power\",\"start\":94.505,\"end\":94.825,\"confidence\":0.9367577},{\"word\":\"both\",\"start\":94.825,\"end\":95.145004,\"confidence\":0.9846039},{\"word\":\"off\",\"start\":95.145004,\"end\":95.305,\"confidence\":0.9451218},{\"word\":\"connector\",\"start\":111.46,\"end\":111.62,\"confidence\":0.60397935},{\"word\":\"your\",\"start\":111.62,\"end\":111.700005,\"confidence\":0.9747545},{\"word\":\"from\",\"start\":112.340004,\"end\":112.5,\"confidence\":0.9991009},{\"word\":\"your\",\"start\":112.5,\"end\":112.58,\"confidence\":0.99836177},{\"word\":\"dc\",\"start\":112.740005,\"end\":113.240005,\"confidence\":0.996846},{\"word\":\"and\",\"start\":113.46,\"end\":113.700005,\"confidence\":0.9974885},{\"word\":\"s\",\"start\":113.700005,\"end\":113.86,\"confidence\":0.9954068},{\"word\":\"the\",\"start\":113.86,\"end\":114.020004,\"confidence\":0.26444715},{\"word\":\"in\",\"start\":114.5,\"end\":114.66,\"confidence\":0.96549934},{\"word\":\"the\",\"start\":114.66,\"end\":114.82,\"confidence\":0.99744415},{\"word\":\"pouch\",\"start\":114.82,\"end\":115.060005,\"confidence\":0.9995932},{\"word\":\"kinda\",\"start\":118.51432,\"end\":118.832504,\"confidence\":0.5401386},{\"word\":\"the\",\"start\":118.832504,\"end\":118.99159,\"confidence\":0.4388202},{\"word\":\"interrupt\",\"start\":118.99159,\"end\":119.15069,\"confidence\":0.36033186},{\"word\":\"so\",\"start\":119.78705,\"end\":120.02569,\"confidence\":0.9887406},{\"word\":\"not\",\"start\":120.02569,\"end\":120.18478,\"confidence\":0.9947384},{\"word\":\"only\",\"start\":120.18478,\"end\":120.50296,\"confidence\":0.98287934},{\"word\":\"does\",\"start\":120.50296,\"end\":120.582504,\"confidence\":0.9591305},{\"word\":\"stephanie\",\"start\":120.74159,\"end\":121.218864,\"confidence\":0.9893464},{\"word\":\"thirty\",\"start\":142.34341,\"end\":142.66159,\"confidence\":0.9927779},{\"word\":\"eight\",\"start\":142.66159,\"end\":142.90022,\"confidence\":0.99224406},{\"word\":\"am\",\"start\":143.05933,\"end\":143.29796,\"confidence\":0.954241},{\"word\":\"central\",\"start\":143.29796,\"end\":143.53659,\"confidence\":0.9984043},{\"word\":\"time\",\"start\":143.53659,\"end\":143.61613,\"confidence\":0.9920243},{\"word\":\"a\",\"start\":143.77522,\"end\":143.85478,\"confidence\":0.96547014},{\"word\":\"little\",\"start\":143.85478,\"end\":144.17296,\"confidence\":0.9974809},{\"word\":\"ahead\",\"start\":144.17296,\"end\":144.2525,\"confidence\":0.9950151},{\"word\":\"of\",\"start\":144.2525,\"end\":144.49113,\"confidence\":0.95926064},{\"word\":\"schedule\",\"start\":144.49113,\"end\":144.80933,\"confidence\":0.9957034},{\"word\":\"about\",\"start\":144.80933,\"end\":145.1275,\"confidence\":0.99563015},{\"word\":\"twelve\",\"start\":145.1275,\"end\":145.36613,\"confidence\":0.99731904},{\"word\":\"minutes\",\"start\":145.36613,\"end\":145.60478,\"confidence\":0.9990018},{\"word\":\"but\",\"start\":145.76387,\"end\":146.26387,\"confidence\":0.9903672},{\"word\":\"that\",\"start\":146.655,\"end\":146.895,\"confidence\":0.9988097},{\"word\":\"gets\",\"start\":146.895,\"end\":147.05501,\"confidence\":0.98660916},{\"word\":\"us\",\"start\":147.05501,\"end\":147.455,\"confidence\":0.9987956},{\"word\":\"started\",\"start\":147.455,\"end\":147.77501,\"confidence\":0.9996424},{\"word\":\"on\",\"start\":147.77501,\"end\":148.015,\"confidence\":0.99905664},{\"word\":\"today's\",\"start\":148.015,\"end\":148.495,\"confidence\":0.99424577},{\"word\":\"historic\",\"start\":148.495,\"end\":148.815,\"confidence\":0.99748397},{\"word\":\"space\",\"start\":148.815,\"end\":149.05501,\"confidence\":0.9847166},{\"word\":\"walk\",\"start\":149.05501,\"end\":149.295,\"confidence\":0.5389857},{\"word\":\"morgan\",\"start\":154.58609,\"end\":154.90443,\"confidence\":0.937771},{\"word\":\"there\",\"start\":154.90443,\"end\":155.40443,\"confidence\":0.9944398},{\"word\":\"wishing\",\"start\":155.54114,\"end\":155.77989,\"confidence\":0.80184084},{\"word\":\"the\",\"start\":155.77989,\"end\":155.93907,\"confidence\":0.9284483},{\"word\":\"crew\",\"start\":155.93907,\"end\":156.09825,\"confidence\":0.9983191},{\"word\":\"luck\",\"start\":156.09825,\"end\":156.17784,\"confidence\":0.76250243},{\"word\":\"the\",\"start\":156.4166,\"end\":156.57578,\"confidence\":0.25588587},{\"word\":\"made\",\"start\":156.57578,\"end\":157.07578,\"confidence\":0.62067413},{\"word\":\"pouch\",\"start\":157.21248,\"end\":157.53082,\"confidence\":0.95132434},{\"word\":\"and\",\"start\":157.53082,\"end\":157.61041,\"confidence\":0.62313336},{\"word\":\"dc\",\"start\":157.69,\"end\":158.16753,\"confidence\":0.66087174},{\"word\":\"cover\",\"start\":158.16753,\"end\":158.48589,\"confidence\":0.97577643},{\"word\":\"closed\",\"start\":158.48589,\"end\":158.64505,\"confidence\":0.37828633},{\"word\":\"copy\",\"start\":162.7236,\"end\":162.9633,\"confidence\":0.99967265},{\"word\":\"e\",\"start\":163.04321,\"end\":163.36282,\"confidence\":0.7775096},{\"word\":\"two\",\"start\":163.36282,\"end\":163.52263,\"confidence\":0.67291963}]}]}]}}","language":"json","status":200},{"code":"{\n \"err_code\": \"INVALID_AUTH\",\n \"err_msg\": \"Invalid credentials.\",\n \"request_id\": \"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":401},{"code":"{\n \"err_code\": \"ASR_PAYMENT_REQUIRED\",\n \"err_msg\": \"Project does not have enough credits for an ASR request and does not have an overage agreement.\",\n \"request_id\": \"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":402},{"code":"{\n \"err_code\":\"Bad Request\",\n \t\"err_msg\":\"Content-type was application/json, but we could not process the JSON payload.\",\n \"request_id\":\"4399e2a5-2b29-4e1e-9456-79043cc88d0a\"\n}","language":"json","status":400},{"code":"{\"err_code\":\"INSUFFICIENT_PERMISSIONS\",\"err_msg\":\"Project does not have access to the requested model.\",\"request_id\":\"3cd19977-9b6d-4c37-9721-85ba0c6f7eb0\"}","language":"json","status":403,"name":"Forbidden"}]}},"title":"Transcribe & Analyze - Remote file","icon":"","type":"endpoint","slug":"listen-remote","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"listen","parentDoc":null,"category":"6466697af06669003714b160","createdAt":"2023-12-28T12:20:40.227Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"65c0edb2328f8000421c3ddf","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Transcribe - Live audio","icon":"","type":"basic","slug":"listen-live","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"listen-live-v2","parentDoc":null,"category":"6466697af06669003714b160","createdAt":"2024-02-05T14:16:18.715Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"656e38a26a272200770e4a42","title":"TEXT TO SPEECH aPI","slug":"speech-to-text","order":3,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-12-04T20:37:54.252Z","__v":0,"pages":[{"_id":"65d7a928f5c2680019c50762","api":{"method":"post","url":"/speak","auth":"never","results":{"codes":[{"code":"HTTP/1.1 200 OK\n< content-type: audio/mpeg\n< dg-model-name: aura-asteria-en\n< dg-model-uuid: e4979ab0-8475-4901-9d66-0a562a4949bb\n< dg-char-count: 32\n< access-control-allow-credentials: true\n< vary: origin\n< vary: access-control-request-method\n< vary: access-control-request-headers\n< dg-request-id: bf6fc5c7-8f84-479f-b70a-602cf5bf18f3\n< transfer-encoding: chunked\n< date: Thu, 29 Feb 2024 19:20:48 GMT","language":"http","status":200,"name":"Response Headers"},{"code":"{\n \"err_code\": \"INSUFFICIENT_PERMISSIONS\",\n \"err_msg\": \"Project does not have access to the requested model.\",\n \"request_id\": \"ef95ffc5-77c5-4420-a026-e25b577fe074\"\n}","language":"json","status":403,"name":null},{"code":"{\n \"err_code\": \"PAYLOAD_ERROR\",\n \"err_msg\": \"Failed to deserialize JSON payload. Please specify exactly one of `text` or `url` in the JSON body.\",\n \"request_id\": \"6a4a05ed-fd00-48ef-9f5a-a2ee6f2dfa9c\"\n}","language":"json","name":"Bad Request","status":400},{"code":"{\n \"err_code\": \"Payload Too Large\",\n \"err_msg\": \"Input text exceeds maximum character limit of 2000.\",\n \"request_id\": \"[unique_request_id]\"\n}","language":"json","name":"Input Text Exceeded Character Limit","status":413},{"code":"{\n \"err_code\": \"UNSUPPORTED_MEDIA_TYPE\",\n \"err_msg\": \" Content-Type header is not supported. Content-Type must be either `text/plain` or `application/json`.\",\n \"request_id\": \"[unique_request_id]\"\n}","language":"json","name":"Unsupported Content Type in Request","status":415}]},"params":[{"name":"bit_rate","type":"string","enumValues":"","default":"","desc":"Specifies the bitrate of the audio output. <a href=\"/docs/tts-bit-rate\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65d7ad5db0d84900631e6154"},{"name":"callback","type":"string","enumValues":"","default":"","desc":"Callback URL to provide if you would like your submitted text to be processed asynchronously. <a href=\"/docs/tts-callback\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65d7ad5db0d84900631e6153"},{"name":"container","type":"string","enumValues":"","default":"","desc":"Specifies the file format wrapper for the output audio. <a href=\"/docs/tts-container\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65d7ad5db0d84900631e6152"},{"name":"encoding","type":"string","enumValues":"","default":"","desc":"Allows you to specify the expected encoding of your audio output. <a href=\"/docs/tts-encoding\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65d7ad5db0d84900631e6151"},{"name":"model","type":"enum","enumValues":"aura-asteria-en, aura-hera-en, aura-luna-en, aura-stella-en, aura-athena-en, aura-zeus-en, aura-orion-en, aura-arcas-en, aura-perseus-en, aura-angus-en, aura-orpheus-en, aura-helios-en","default":"aura-asteria-en","desc":"AI model used to synthesize text into speech. Default: `aura-asteria-en`. <a href=\"/docs/tts-models\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65e119da94cbf5027efd66a4"},{"name":"sample_rate","type":"string","enumValues":"","default":"","desc":"Specifies the sample rate for the output audio. <a href=\"/docs/tts-sample-rate\">Learn More</a>.","required":false,"in":"query","ref":"","_id":"65d7ad5db0d84900631e6150"},{"name":"text","type":"string","enumValues":"","default":"Hello, how can I help you today?","desc":"Send text as a string or text/plain.","required":false,"in":"body","ref":"","_id":"65d7ad5db0d84900631e614f"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"65d7ad5db0d84900631e614e"},{"name":"Accept","type":"array_string","enumValues":"","default":"audio/mpeg,audio/wav","desc":"","required":false,"in":"header","ref":"","_id":"6750adb7730e9c003e386e17"}],"examples":{"codes":[{"code":"const fetch = require('node-fetch'); \n\nconst url = 'https://api.deepgram.com/v1/speak?model=aura-asteria-en'; \nconst options = { \n method: 'POST', \n headers: {'Content-Type': 'application/json'}, \n body: JSON.stringify({text: 'Hello, how can I help you today?'}) \n}; \n \n fetch(url, options)\n .then(res => res.json())\n .then(json => console.log(json))\n .catch(err => console.error('error:' + err));\n","language":"node","name":null},{"code":"using System;\nusing System.Net.Http;\nusing System.Text;\nusing System.Threading.Tasks;\nusing System.IO;\n\nclass Program\n{\n static async Task Main(string[] args)\n {\n // Define your JSON object\n string json = \"{\\\"text\\\": \\\"Hello, how can I help you today?\\\"}\";\n\n // URL to which you want to send the request\n string url = \"https://api.deepgram.com/v1/speak\"; // Replace with your actual endpoint URL\n\n // API Key\n string apiKey = \"YOUR_DEEPGRAM_API_KEY\"; // Replace with your actual API key\n\n // Create an instance of HttpClient\n using (HttpClient httpClient = new HttpClient())\n {\n try\n {\n // Prepare the HTTP request content\n HttpContent content = new StringContent(json, Encoding.UTF8, \"application/json\");\n\n // Add Authorization header\n httpClient.DefaultRequestHeaders.Add(\"Authorization\", \"token \" + apiKey);\n\n // Send the POST request\n HttpResponseMessage response = await httpClient.PostAsync(url, content);\n\n // Check if the request was successful\n if (response.IsSuccessStatusCode)\n {\n // Read and save the response as binary data\n using (Stream audioStream = await response.Content.ReadAsStreamAsync())\n {\n // Specify where you want to save the audio file\n string filePath = \"your_output_file.mp3\";\n using (FileStream fileStream = File.Create(filePath))\n {\n using (BinaryWriter writer = new BinaryWriter(fileStream))\n {\n // Copy the binary data from the response stream to the file stream\n byte[] buffer = new byte[8192];\n int bytesRead;\n while ((bytesRead = await audioStream.ReadAsync(buffer, 0, buffer.Length)) > 0)\n {\n writer.Write(buffer, 0, bytesRead);\n }\n }\n }\n Console.WriteLine(\"Audio file saved successfully.\");\n }\n }\n else\n {\n Console.WriteLine(\"Request failed with status code: \" + response.StatusCode);\n }\n }\n catch (Exception ex)\n {\n Console.WriteLine(\"Error: \" + ex.Message);\n }\n }\n }\n}","language":"csharp","name":"HTTPCLIENT"},{"code":"from deepgram import (\n DeepgramClient,\n SpeakOptions,\n)\n\nSPEAK_OPTIONS = {\"text\": \"Hello, how can I help you today?\"}\nfilename = \"your_output_file.mp3\"\n\n\ndef main():\n try:\n deepgram = DeepgramClient(\"DEEPGRAM_API_KEY\")\n\n options = SpeakOptions(\n model=\"aura-asteria-en\",\n )\n\n response = deepgram.speak.v(\"1\").save(filename, SPEAK_OPTIONS, options)\n print(response.to_json(indent=4))\n\n except Exception as e:\n print(f\"Exception: {e}\")","language":"python","name":"SDK"},{"code":"import requests\n\nurl = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\"\nheaders = {\n \"Authorization\": \"Token DEEPGRAM_API_KEY\",\n \"Content-Type\": \"application/json\"\n}\npayload = {\n \"text\": \"Hello, how can I help you today?\"\n}\n\nresponse = requests.post(url, headers=headers, json=payload)\n\nif response.status_code == 200:\n with open(\"your_output_file.mp3\", \"wb\") as f:\n f.write(response.content)\n print(\"File saved successfully.\")\nelse:\n print(f\"Error: {response.status_code} - {response.text}\")\n","language":"python","name":"Requests"},{"code":"import http.client\nimport json\n\nurl = \"api.deepgram.com\"\nrequest_body = json.dumps({\"text\": \"Hello, how can I help you today?\"})\nheaders = {\n \"Authorization\": \"Token DEEPGRAM_API_KEY\", # Replace with your Deepgram API key\n \"Content-Type\": \"application/json\"\n}\n\nconn = http.client.HTTPSConnection(url)\n\nconn.request(\"POST\", \"/v1/speak?model=aura-asteria-en\", request_body, headers)\n\nresponse = conn.getresponse()\n\noutput_file_path = \"your_output_file.mp3\"\nwith open(output_file_path, \"wb\") as output_file:\n output_file.write(response.read())\n\nconn.close()\n\nprint(\"File saved successfully at:\", output_file_path)\n","language":"python","name":"HTTP Client"},{"code":"const { createClient } = require(\"@deepgram/sdk\");\nconst fs = require(\"fs\");\n\nconst deepgram = createClient(process.env.DEEPGRAM_API_KEY);\n\nconst text = \"Hello, how can I help you today?\";\n\nconst getAudio = async () => {\n const response = await deepgram.speak.request(\n { text },\n {\n model: \"aura-asteria-en\",\n encoding: \"linear16\",\n container: \"wav\",\n }\n );\n\n const stream = await response.getStream();\n const headers = await response.getHeaders();\n if (stream) {\n const buffer = await getAudioBuffer(stream);\n fs.writeFile(\"output.wav\", buffer, (err) => {\n if (err) {\n console.error(\"Error writing audio to file:\", err);\n } else {\n console.log(\"Audio file written to output.wav\");\n }\n });\n } else {\n console.error(\"Error generating audio:\", stream);\n }\n\n if (headers) {\n console.log(\"Headers:\", headers);\n }\n};\n\n// helper function to convert stream to audio buffer\nconst getAudioBuffer = async (response) => {\n const reader = response.getReader();\n const chunks = [];\n\n while (true) {\n const { done, value } = await reader.read();\n if (done) break;\n\n chunks.push(value);\n }\n\n const dataArray = chunks.reduce(\n (acc, chunk) => Uint8Array.from([...acc, ...chunk]),\n new Uint8Array(0)\n );\n\n return Buffer.from(dataArray.buffer);\n};\n\ngetAudio();","language":"javascript","name":"SDK"},{"code":"const https = require(\"https\");\nconst fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\nconst apiKey = \"DEEPGRAM_API_KEY\";\nconst data = JSON.stringify({\n text: \"Hello, how can I help you today?\",\n});\n\nconst options = {\n method: \"POST\",\n headers: {\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n },\n};\n\nconst req = https.request(url, options, (res) => {\n if (res.statusCode !== 200) {\n console.error(`HTTP error! Status: ${res.statusCode}`);\n return;\n }\n\n const dest = fs.createWriteStream(\"output.mp3\");\n res.pipe(dest);\n dest.on(\"finish\", () => {\n console.log(\"File saved successfully.\");\n });\n});\n\nreq.on(\"error\", (error) => {\n console.error(\"Error:\", error);\n});\n\nreq.write(data);\nreq.end();\n","language":"javascript","name":"https"},{"code":"package main\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\n\tprettyjson \"github.com/hokaccha/go-prettyjson\"\n\n\tspeak \"github.com/deepgram/deepgram-go-sdk/pkg/api/speak/v1\"\n\tinterfaces \"github.com/deepgram/deepgram-go-sdk/pkg/client/interfaces\"\n\tclient \"github.com/deepgram/deepgram-go-sdk/pkg/client/speak\"\n)\n\nconst (\n\ttextToSpeech string = \"Hello, how can I help you today?\"\n\tfilePath string = \"./output.wav\"\n)\n\nfunc main() {\n\tclient.InitWithDefault()\n\n\tctx := context.Background()\n\n\toptions := interfaces.SpeakOptions{\n\t\tModel: \"aura-asteria-en\",\n\t\tEncoding: \"linear16\",\n\t\tContainer: \"wav\",\n\t}\n\n\t// NOTE: you can set your API KEY in your bash profile by typing the following line in your shell:\n\t// export DEEPGRAM_API_KEY = \"YOUR_DEEPGRAM_API_KEY\"\n\tc := client.NewWithDefaults()\n\tdg := speak.New(c)\n\n\tres, err := dg.ToSave(ctx, filePath, textToSpeech, options)\n\tif err != nil {\n\t\tfmt.Printf(\"FromStream failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tdata, err := json.Marshal(res)\n\tif err != nil {\n\t\tfmt.Printf(\"json.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tprettyJson, err := prettyjson.Format(data)\n\tif err != nil {\n\t\tfmt.Printf(\"prettyjson.Marshal failed. Err: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\tfmt.Printf(\"\\n\\nResult:\\n%s\\n\\n\", prettyJson)\n}\n","language":"go","name":"SDK"},{"code":"package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n\t\"strings\"\n)\n\nfunc main() {\n\turl := \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\"\n\tapiKey := \"DEEPGRAM_API_KEY\"\n\tpayload := strings.NewReader(`{\"text\": \"Hello, how can I help you today?\"}`)\n\n\tclient := &http.Client{}\n\treq, err := http.NewRequest(\"POST\", url, payload)\n\tif err != nil {\n\t\tfmt.Println(\"Error creating request:\", err)\n\t\treturn\n\t}\n\n\treq.Header.Set(\"Authorization\", \"Token \"+apiKey)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(\"Error making request:\", err)\n\t\treturn\n\t}\n\tdefer resp.Body.Close()\n\n\tif resp.StatusCode != http.StatusOK {\n\t\tfmt.Printf(\"HTTP error! Status: %d\\n\", resp.StatusCode)\n\t\treturn\n\t}\n\n\toutputFile, err := os.Create(\"your_output_file.mp3\")\n\tif err != nil {\n\t\tfmt.Println(\"Error creating output file:\", err)\n\t\treturn\n\t}\n\tdefer outputFile.Close()\n\n\t_, err = io.Copy(outputFile, resp.Body)\n\tif err != nil {\n\t\tfmt.Println(\"Error copying response body:\", err)\n\t\treturn\n\t}\n\n\tfmt.Println(\"File saved successfully.\")\n}\n","language":"go","name":"net/http"},{"code":"const axios = require(\"axios\");\nconst fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\nconst apiKey = \"DEEPGRAM_API_KEY\";\nconst data = {\n text: \"Hello, how can I help you today?\",\n};\n\nconst config = {\n headers: {\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n },\n responseType: \"stream\", // Ensure the response is treated as a stream\n};\n\naxios\n .post(url, data, config)\n .then((response) => {\n if (response.status !== 200) {\n console.error(`HTTP error! Status: ${response.status}`);\n return;\n }\n\n const dest = fs.createWriteStream(\"output.mp3\");\n response.data.pipe(dest);\n dest.on(\"finish\", () => {\n console.log(\"File saved successfully.\");\n });\n })\n .catch((error) => {\n console.error(\"Error:\", error.message);\n });\n","language":"javascript","name":"axios"},{"code":"const fs = require(\"fs\");\n\nconst url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\nconst apiKey = \"DEEPGRAM_API_KEY\";\nconst outputFilePath = \"output_file.mp3\";\n\nconst body = JSON.stringify({\n text: \"Hello, how can I help you today?\",\n});\n\nconst headers = {\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n};\n\nconst options = {\n method: \"POST\",\n headers: headers,\n body: body,\n};\n\nfetch(url, options)\n .then((response) => {\n if (!response.ok) {\n throw new Error(\"Failed to make request:\", response.statusText);\n }\n return response.blob();\n })\n .then((blob) => {\n const reader = blob.stream().getReader();\n\n const fileStream = fs.createWriteStream(outputFilePath);\n reader.read().then(function processText({ done, value }) {\n if (done) {\n console.log(\"File downloaded successfully.\");\n return;\n }\n fileStream.write(Buffer.from(value));\n return reader.read().then(processText);\n });\n })\n .catch((error) => {\n console.error(\"Error:\", error);\n });\n","language":"javascript","name":"fetch"},{"code":"import fs from \"fs\";\nimport fetch from \"node-fetch\";\n\nconst url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\nconst apiKey = \"DEEPGRAM_API_KEY\";\nconst outputFilePath = \"output_file.mp3\";\n\nconst body = JSON.stringify({\n text: \"Hello, how can I help you today?\",\n});\n\nconst headers = {\n Authorization: `Token ${apiKey}`,\n \"Content-Type\": \"application/json\",\n};\n\nconst options = {\n method: \"POST\",\n headers: headers,\n body: body,\n};\n\nfetch(url, options)\n .then((response) => {\n if (!response.ok) {\n throw new Error(\"Failed to make request:\", response.statusText);\n }\n return response.buffer();\n })\n .then((data) => {\n fs.writeFileSync(outputFilePath, data);\n console.log(\"File downloaded successfully.\");\n })\n .catch((error) => {\n console.error(\"Error:\", error);\n });\n","language":"javascript","name":"node-fetch"},{"code":"#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <curl/curl.h>\n\nint main(void) {\n CURL *curl;\n CURLcode res;\n\n curl = curl_easy_init();\n if(curl) {\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\");\n headers = curl_slist_append(headers, \"Content-Type: application/json\");\n\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\");\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n\n const char *data = \"{\\\"text\\\": \\\"Hello, how can I help you today?\\\"}\"; // JSON data\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);\n\n FILE *file = fopen(\"your_output_file.mp3\", \"wb\");\n if (!file) {\n fprintf(stderr, \"Error: Unable to open output file\\n\");\n return 1;\n }\n curl_easy_setopt(curl, CURLOPT_WRITEDATA, file);\n\n res = curl_easy_perform(curl);\n if(res != CURLE_OK)\n fprintf(stderr, \"curl_easy_perform() failed: %s\\n\", curl_easy_strerror(res));\n\n curl_slist_free_all(headers);\n curl_easy_cleanup(curl);\n fclose(file);\n }\n return 0;\n}\n","language":"c"},{"code":"#include <iostream>\n#include <curl/curl.h>\n\nint main() {\n CURL *curl;\n CURLcode res;\n\n curl = curl_easy_init();\n if(curl) {\n curl_easy_setopt(curl, CURLOPT_URL, \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\");\n\n struct curl_slist *headers = NULL;\n headers = curl_slist_append(headers, \"Authorization: Token DEEPGRAM_API_KEY\"); // Replace YOUR_DEEPGRAM_API_KEY with your actual API key\n headers = curl_slist_append(headers, \"Content-Type: application/json\");\n curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);\n\n curl_easy_setopt(curl, CURLOPT_POSTFIELDS, \"{\\\"text\\\": \\\"Hello, how can I help you today?\\\"}\");\n \n FILE *fp = fopen(\"your_output_file.mp3\", \"wb\");\n if (fp == NULL) {\n std::cerr << \"Failed to create output file.\" << std::endl;\n return 1;\n }\n\n curl_easy_setopt(curl, CURLOPT_WRITEDATA, fp);\n \n res = curl_easy_perform(curl);\n\n curl_slist_free_all(headers);\n curl_easy_cleanup(curl);\n fclose(fp);\n\n if(res != CURLE_OK)\n std::cerr << \"curl_easy_perform() failed: \" << curl_easy_strerror(res) << std::endl;\n }\n return 0;\n}\n","language":"cplusplus"},{"code":"Code example coming soon","language":"clojure"},{"code":"import okhttp3.*;\n\nimport java.io.FileOutputStream;\nimport java.io.IOException;\n\npublic class Main {\n public static void main(String[] args) throws IOException {\n String apiKey = \"DEEPGRAM_API_KEY\"; // Replace DEEPGRAM_API_KEY with your actual API key\n String url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\n String text = \"{\\\"text\\\": \\\"Hello, how can I help you today?\\\"}\";\n String outputFile = \"your_output_file.mp3\";\n\n OkHttpClient client = new OkHttpClient();\n\n RequestBody requestBody = RequestBody.create(MediaType.parse(\"application/json\"), text);\n Request request = new Request.Builder()\n .url(url)\n .header(\"Authorization\", \"Token \" + apiKey)\n .post(requestBody)\n .build();\n\n try (Response response = client.newCall(request).execute()) {\n if (!response.isSuccessful()) {\n throw new IOException(\"Unexpected response code: \" + response);\n }\n\n try (FileOutputStream fos = new FileOutputStream(outputFile)) {\n fos.write(response.body().bytes());\n System.out.println(\"Audio file saved: \" + outputFile);\n }\n }\n }\n}\n\n","language":"java","name":"okhttp3"},{"code":"\nimport java.io.FileOutputStream;\nimport java.io.IOException;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n String apiKey = \"DEEPGRAM_API_KEY\"; // Replace DEEPGRAM_API_KEY with your actual API key\n String url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\n String text = \"{\\\"text\\\": \\\"Hello, how can I help you today?\\\"}\";\n String outputFile = \"your_output_file.mp3\";\n\n HttpClient httpClient = HttpClient.newHttpClient();\n \n HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Token \" + apiKey)\n .header(\"Content-Type\", \"application/json\")\n .POST(HttpRequest.BodyPublishers.ofString(text))\n .build();\n\n HttpResponse<byte[]> response = httpClient.send(request, HttpResponse.BodyHandlers.ofByteArray());\n\n if (response.statusCode() == 200) {\n byte[] audioData = response.body();\n Path outputPath = Paths.get(outputFile);\n Files.write(outputPath, audioData);\n System.out.println(\"Audio file saved: \" + outputPath);\n } else {\n System.err.println(\"Error: \" + response.statusCode() + \" - \" + response.body());\n }\n }\n}\n","language":"java","name":"HTTPClient"},{"code":"Code example coming soon","language":"kotlin"},{"code":"Code example coming soon","language":"objectivec"},{"code":"Code example coming soon","language":"ocaml"},{"code":"<?php\n\n$url = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\";\n$api_key = \"DEEPGRAM_API_KEY\";\n$data = array(\n 'text' => \"Hello, how can I help you today?\"\n);\n\n$ch = curl_init();\n\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n 'Authorization: Token ' . $api_key,\n 'Content-Type: application/json'\n));\n\n$response = curl_exec($ch);\n\nif(curl_errno($ch)) {\n echo 'Error: ' . curl_error($ch);\n}\n\ncurl_close($ch);\n\nfile_put_contents('your_output_file.mp3', $response);\n\n?>\n","language":"php"},{"code":"Code example coming soon","language":"powershell"},{"code":"Code example coming soon","language":"r"},{"code":"require 'net/http'\nrequire 'uri'\n\nuri = URI.parse(\"https://api.deepgram.com/v1/speak?model=aura-asteria-en\")\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest['Authorization'] = 'Token DEEPGRAM_API_KEY' # Replace with your Deepgram API key\nrequest['Content-Type'] = 'application/json'\nrequest.body = '{\"text\": \"Hello, how can I help you today?\"}'\n\nresponse = http.request(request)\n\nif response.code == '200'\n File.open('your_output_file.mp3', 'wb') do |file|\n file.write(response.body)\n end\n puts 'File saved successfully.'\nelse\n puts \"Error: #{response.code} #{response.message}\"\nend\n","language":"ruby","name":"net/http"},{"code":"require 'httparty'\n\nurl = \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\"\nheaders = {\n \"Authorization\" => \"Token DEEPGRAM_API_KEY\", # Replace with your Deepgram API key\n \"Content-Type\" => \"application/json\"\n}\nbody = {\n \"text\" => \"Hello, how can I help you today?\"\n}\n\nresponse = HTTParty.post(url, headers: headers, body: body.to_json)\n\nif response.code == 200\n File.open('your_output_file.mp3', 'wb') do |file|\n file.write(response.body)\n end\n puts 'File saved successfully.'\nelse\n puts \"Error: #{response.code} #{response.message}\"\nend\n","language":"ruby","name":"httparty"},{"code":"import Foundation\n\n// Specify the URL for the Deepgram API endpoint\nlet url = URL(string: \"https://api.deepgram.com/v1/speak?model=aura-asteria-en\")!\n\n// Replace DEEPGRAM_API_KEY with your actual API key\nlet apiKey = \"DEEPGRAM_API_KEY\"\n\n// Text to be converted to speech\nlet textToSpeak = \"Hello, how can I help you today?\"\n\n// Create the URLRequest object\nvar request = URLRequest(url: url)\nrequest.httpMethod = \"POST\"\n\n// Set request headers\nrequest.setValue(\"Token \\(apiKey)\", forHTTPHeaderField: \"Authorization\")\nrequest.setValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\n\n// Create request body with text data\nlet textData = [\"text\": textToSpeak]\nlet jsonData = try! JSONSerialization.data(withJSONObject: textData)\nrequest.httpBody = jsonData\n\n// Create URLSession task to perform the request\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in\n if let error = error {\n print(\"Error: \\(error)\")\n return\n }\n \n guard let httpResponse = response as? HTTPURLResponse, (200...299).contains(httpResponse.statusCode) else {\n print(\"Error: Invalid response\")\n return\n }\n \n if let audioData = data {\n do {\n // Specify the path to save the output MP3 file\n let outputPath = \"your_output_file.mp3\"\n try audioData.write(to: URL(fileURLWithPath: outputPath))\n print(\"MP3 file saved at: \\(outputPath)\")\n } catch {\n print(\"Error saving MP3 file: \\(error)\")\n }\n } else {\n print(\"Error: No response data\")\n }\n}\n\n// Start the URLSession task\ntask.resume()\n\n// Keep the program running until the URLSession task completes\nRunLoop.main.run()\n","language":"swift"}]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Transform Text-to-Speech - REST","icon":"","type":"endpoint","slug":"text-to-speech-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tts-api","category":"656e38a26a272200770e4a42","createdAt":"2024-02-22T20:06:00.743Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66c5075203ad35004a8a55dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Transform Text-to-Speech - Streaming","icon":"","type":"basic","slug":"transform-text-to-speech-websocket","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"656e38a26a272200770e4a42","createdAt":"2024-08-20T21:14:58.543Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"65bd1459a8f9cd0063a614a1","title":"Text Intelligence API","slug":"text-to-text-api","order":4,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2024-02-02T16:12:09.956Z","__v":0,"pages":[{"_id":"65bd24d930dcf50023f5eefd","api":{"method":"post","url":"/read","auth":"required","results":{"codes":[{"name":"","code":"{\n \"metadata\": {\n \"request_id\": \"9a110df0-17bb-40ec-94c2-3cb7f862a045\",\n \"created\": \"2024-02-02T19:00:43.271Z\",\n \"language\": \"en\",\n \"summary_info\": {\n \"model_uuid\": \"67875a7f-c9c4-48a0-aa55-5bdb8a91c34a\",\n \"input_tokens\": 1855,\n \"output_tokens\": 123\n },\n \"sentiment_info\": {\n \"model_uuid\": \"ba5b22e4-b39a-4550-a4bc-d8655f5092bc\",\n \"input_tokens\": 2043,\n \"output_tokens\": 2047\n },\n \"topics_info\": {\n \"model_uuid\": \"ba5b22e4-b39a-4550-a4bc-d8655f5092bc\",\n \"input_tokens\": 2043,\n \"output_tokens\": 225\n },\n \"intents_info\": {\n \"model_uuid\": \"ba5b22e4-b39a-4550-a4bc-d8655f5092bc\",\n \"input_tokens\": 2043,\n \"output_tokens\": 65\n }\n },\n \"results\": {\n \"summary\": {\n \"text\": \"The potential for voice-based interfaces in conversational AI applications is discussed, with a focus on voice-premises and wearable devices. The success of voice-first experiences and tools, including DeepgramQuad, has led to rapid development of these technologies. The speakers emphasize the benefits of voice quality, including the ability to swap between voices, the naturalness of the flow of conversations, and the importance of tailoring voice to specific applications. They also discuss the potential for AI to be a panacea for speech recognition and text-to-speech capabilities, with a focus on speed, quality, and cost-efficiency.\"\n },\n \"topics\": {\n \"segments\": [\n {\n \"text\": \"Meet Deepgram Aura: real-time text-to-speech for real-time AI agents ---------- It’s been a year since large language models (LLMs) seemingly went mainstream overnight (Happy Birthday, ChatGPT!!!), and the world has witnessed both rapid development of these technologies and immense interest in their potential.\",\n \"start_word\": 1,\n \"end_word\": 43,\n \"topics\": [\n {\n \"topic\": \"Real-time text-to-speech\",\n \"confidence_score\": 0.02132084\n }\n ]\n },\n {\n \"text\": \"We believe that we have reached an inflection point where voice-based interfaces will be the primary means to accessing LLMs and the experiences they unlock.\",\n \"start_word\": 43,\n \"end_word\": 67,\n \"topics\": [\n {\n \"topic\": \"Llms experiences\",\n \"confidence_score\": 0.017349197\n },\n {\n \"topic\": \"Voice-based interfaces\",\n \"confidence_score\": 0.79457426\n }\n ]\n },\n {\n \"text\": \"Thanks to ChatGPT and the advent of the LLM era, the conversational AI tech stack has advanced sufficiently to support productive (not frustrating) voice-powered AI assistants and agents that can interact with humans in a natural manner.\",\n \"start_word\": 158,\n \"end_word\": 194,\n \"topics\": [\n {\n \"topic\": \"Voice-powered ai agents\",\n \"confidence_score\": 0.0036265212\n }\n ]\n },\n {\n \"text\": \"That’s why we’re excited to introduce our own text-to-speech (TTS) API, Deepgram Aura, built for real-time, conversational voice AI agents.\",\n \"start_word\": 270,\n \"end_word\": 289,\n \"topics\": [\n {\n \"topic\": \"Conversational ai\",\n \"confidence_score\": 0.26679963\n }\n ]\n },\n {\n \"text\": \"We are thrilled about the progress our initial group of developers has made using Aura, so much so that we are extending limited access to a select few partners who will be free to begin integrating with Aura immediately.\",\n \"start_word\": 333,\n \"end_word\": 371,\n \"topics\": [\n {\n \"topic\": \"Aura integration\",\n \"confidence_score\": 0.2293859\n }\n ]\n },\n {\n \"text\": \"High Production is all about crafting the perfect voice. It's used in projects where every tone and inflection matters, like in video games or audiobooks, to really bring a scene or story to life.\",\n \"start_word\": 434,\n \"end_word\": 467,\n \"topics\": [\n {\n \"topic\": \"High throughput\",\n \"confidence_score\": 0.4301796\n }\n ]\n },\n {\n \"text\": \"High Production is all about crafting the perfect voice. It's used in projects where every tone and inflection matters, like in video games or audiobooks, to really bring a scene or story to life. Here, voice quality is king, with creators investing hours to fine-tune every detail for a powerful emotional impact.\",\n \"start_word\": 434,\n \"end_word\": 485,\n \"topics\": [\n {\n \"topic\": \"Voice ai technology\",\n \"confidence_score\": 0.5011565\n }\n ]\n },\n {\n \"text\": \"These tasks are relevant to just about everyone on the planet, and they require fast, efficient text-to-speech conversion for an AI agent to fulfill them.\",\n \"start_word\": 569,\n \"end_word\": 593,\n \"topics\": [\n {\n \"topic\": \"Text-to-speech conversion\",\n \"confidence_score\": 0.56403285\n },\n {\n \"topic\": \"Importance of text-to-speech\",\n \"confidence_score\": 0.0008262385\n }\n ]\n },\n {\n \"text\": \"While voice quality is still important to keep users engaged, quality here is more about the naturalness of the flow of conversation and less about sounding like Morgan Freeman.\",\n \"start_word\": 594,\n \"end_word\": 622,\n \"topics\": [\n {\n \"topic\": \"Conversation quality\",\n \"confidence_score\": 0.0012676471\n }\n ]\n },\n {\n \"text\": \"While voice quality is still important to keep users engaged, quality here is more about the naturalness of the flow of conversation and less about sounding like Morgan Freeman. But the primary focus for most customers in this category is on improving customer outcomes, meaning speed and efficiency are must-haves for ensuring these everyday exchanges are smooth and reliable at high volume.\",\n \"start_word\": 594,\n \"end_word\": 655,\n \"topics\": [\n {\n \"topic\": \"Quality assurance\",\n \"confidence_score\": 0.08728356\n },\n {\n \"topic\": \"User engagement\",\n \"confidence_score\": 0.011892504\n }\n ]\n },\n {\n \"text\": \"And our customers would be more than satisfied with the conversation quality.\\\" Jordan Dearsley, Co-founder at Vapi Although high production use cases seem to be well-served with UI-centric production tools, high throughput, real-time use cases still mostly rely on APIs provided by the major cloud providers.\",\n \"start_word\": 672,\n \"end_word\": 717,\n \"topics\": [\n {\n \"topic\": \"Conversation quality\",\n \"confidence_score\": 0.9803023\n }\n ]\n },\n {\n \"text\": \"Furthermore, we are dedicated to tailoring these voices to their specific applications, ensuring they remain composed and articulate, particularly in enunciating account numbers and business names with precision.\",\n \"start_word\": 818,\n \"end_word\": 845,\n \"topics\": [\n {\n \"topic\": \"Ai-based voice recognition\",\n \"confidence_score\": 0.003596105\n }\n ]\n },\n {\n \"text\": \"The quality and overall performance will continue to improve with additional model training and refinement. We encourage you to give them a listen and note the naturalness of their cadence, rhythm, and tone in the flow of conversation with another human.\",\n \"start_word\": 953,\n \"end_word\": 993,\n \"topics\": [\n {\n \"topic\": \"Aura performance\",\n \"confidence_score\": 0.0024802522\n }\n ]\n },\n {\n \"text\": \"Along the way, we’ve transcribed trillions of spoken words into highly accurate transcriptions.\",\n \"start_word\": 1018,\n \"end_word\": 1030,\n \"topics\": [\n {\n \"topic\": \"Api-based transcriptions\",\n \"confidence_score\": 0.004975504\n }\n ]\n },\n {\n \"text\": \"Our model research team has developed novel transformer architectures equipped to deal with the nuances of conversational audio–across different languages, accents, and dialects, while handling disfluencies and the changing rhythms, tones, cadences, and inflections that occur in natural, back-and-forth conversations.\",\n \"start_word\": 1032,\n \"end_word\": 1071,\n \"topics\": [\n {\n \"topic\": \"Languages\",\n \"confidence_score\": 0.0004280001\n }\n ]\n },\n {\n \"text\": \"So what can you expect from Aura? Delivering the same market-leading value and performance as Nova-2 does for STT. Aura is built to be the panacea for speed, quality, and efficiency–the fastest of the high-quality options, and the best quality of the fast ones.\",\n \"start_word\": 1223,\n \"end_word\": 1266,\n \"topics\": [\n {\n \"topic\": \"Aura\",\n \"confidence_score\": 0.3260436\n },\n {\n \"topic\": \"Aura\",\n \"confidence_score\": 0.032662213\n }\n ]\n },\n {\n \"text\": \"Delivering the same market-leading value and performance as Nova-2 does for STT. Aura is built to be the panacea for speed, quality, and efficiency–the fastest of the high-quality options, and the best quality of the fast ones.\",\n \"start_word\": 1230,\n \"end_word\": 1266,\n \"topics\": [\n {\n \"topic\": \"Performance\",\n \"confidence_score\": 0.0063725146\n }\n ]\n },\n {\n \"text\": \"\\\"Deepgram is a valued partner, providing our customers with high throughput speech-to-text that delivers unrivaled performance without tradeoffs between quality, speed, and cost.\",\n \"start_word\": 1284,\n \"end_word\": 1306,\n \"topics\": [\n {\n \"topic\": \"Speech-to-text\",\n \"confidence_score\": 0.20689109\n }\n ]\n }\n ]\n },\n \"intents\": {\n \"segments\": [\n {\n \"text\": \"That’s why we’re excited to introduce our own text-to-speech (TTS) API, Deepgram Aura, built for real-time, conversational voice AI agents.\",\n \"start_word\": 270,\n \"end_word\": 289,\n \"intents\": [\n {\n \"intent\": \"Introduce deepgram ura\",\n \"confidence_score\": 0.72176206\n },\n {\n \"intent\": \"Provide voice-based agents\",\n \"confidence_score\": 0.0034496784\n }\n ]\n },\n {\n \"text\": \"Here, voice quality is king, with creators investing hours to fine-tune every detail for a powerful emotional impact.\",\n \"start_word\": 468,\n \"end_word\": 485,\n \"intents\": [\n {\n \"intent\": \"Demonstrate quality\",\n \"confidence_score\": 0.000025880421\n }\n ]\n },\n {\n \"text\": \"The quality and overall performance will continue to improve with additional model training and refinement. We encourage you to give them a listen and note the naturalness of their cadence, rhythm, and tone in the flow of conversation with another human.\",\n \"start_word\": 953,\n \"end_word\": 993,\n \"intents\": [\n {\n \"intent\": \"Enhance voice performance\",\n \"confidence_score\": 0.0164178\n }\n ]\n },\n {\n \"text\": \"And all the while, we’ve purposefully built our models under limited constraints to optimize their speed and efficiency.\",\n \"start_word\": 1071,\n \"end_word\": 1088,\n \"intents\": [\n {\n \"intent\": \"Optimize audio performance\",\n \"confidence_score\": 0.28505138\n }\n ]\n }\n ]\n },\n \"sentiments\": {\n \"segments\": [\n {\n \"text\": \"Meet Deepgram Aura: real-time text-to-speech for real-time AI agents ---------- It’s been a year since large language models (LLMs) seemingly went mainstream overnight (Happy Birthday, ChatGPT!!!), and the world has witnessed both rapid development of these technologies and immense interest in their potential.\",\n \"start_word\": 0,\n \"end_word\": 42,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.18202751874923703\n },\n {\n \"text\": \"We believe that we have reached an inflection point where voice-based interfaces will be the primary means to accessing LLMs and the experiences they unlock. Here are a few recent signals in support of our thesis: - Good old fashioned voice notes are enjoying a healthy resurgence.\",\n \"start_word\": 43,\n \"end_word\": 89,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.38409921526908875\n },\n {\n \"text\": \"- According to a recent survey, a majority of respondents stated phone calls are still their preferred communication channel for resolving customer service issues. - An emerging boom in wearable devices equipped with continuous listening and speech AI technology is gaining steam. - OpenAI recently enabled voice interactions in ChatGPT. - A wave of interest in voice-first experiences and tools is sweeping across brands, investors, and tech companies.\",\n \"start_word\": 90,\n \"end_word\": 157,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.2346823811531067\n },\n {\n \"text\": \"Thanks to ChatGPT and the advent of the LLM era, the conversational AI tech stack has advanced sufficiently to support productive (not frustrating) voice-powered AI assistants and agents that can interact with humans in a natural manner.\",\n \"start_word\": 158,\n \"end_word\": 194,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4896208047866822\n },\n {\n \"text\": \"We have already observed this from our most innovative customers who are actively turning to these technologies to build a diverse range of AI agents for voice ordering systems, interview bots, personal AI assistants, automated drive-thru tellers, and autonomous sales and customer service agents.\",\n \"start_word\": 195,\n \"end_word\": 238,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.26346486806869507\n },\n {\n \"text\": \"While these AI agents hold immense potential, many customers have expressed their dissatisfaction with the current crop of voice AI vendors, citing roadblocks related to speed, cost, reliability, and conversational quality.\",\n \"start_word\": 239,\n \"end_word\": 269,\n \"sentiment\": \"negative\",\n \"sentiment_score\": -0.4057016372680664\n },\n {\n \"text\": \"That’s why we’re excited to introduce our own text-to-speech (TTS) API, Deepgram Aura, built for real-time, conversational voice AI agents. Whether used on its own or in conjunction with our industry-leading Nova-2 speech-to-text API, we’ll soon provide developers with a complete speech AI platform, giving them the essential building blocks they need to build high throughput, real-time AI agents of the future.\",\n \"start_word\": 270,\n \"end_word\": 331,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4036688804626465\n },\n {\n \"text\": \"We are thrilled about the progress our initial group of developers has made using Aura, so much so that we are extending limited access to a select few partners who will be free to begin integrating with Aura immediately. With their feedback, we’ll continue to enhance our suite of voices and API features, as well as ensure a smooth launch of their production-grade applications.\",\n \"start_word\": 332,\n \"end_word\": 395,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.6666476130485535\n },\n {\n \"text\": \"What Customers Want ---------- I feel the need, the need for speed What we’ve heard from many of our customers and partners is that voice AI technology today caters to two main areas: high production or high throughput. High Production is all about crafting the perfect voice.\",\n \"start_word\": 396,\n \"end_word\": 442,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.10989074409008026\n },\n {\n \"text\": \"It's used in projects where every tone and inflection matters, like in video games or audiobooks, to really bring a scene or story to life. Here, voice quality is king, with creators investing hours to fine-tune every detail for a powerful emotional impact. The primary benefit is the ability to swap out a high-paid voice actor with AI where you have more dynamic control over what’s being said while also achieving some cost savings. But these use cases are more specialized and represent just a sliver of the overall voice AI opportunity.\",\n \"start_word\": 443,\n \"end_word\": 534,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4490419030189514\n },\n {\n \"text\": \"On the flip side, High Throughput is about handling many quick, one-off interactions for real-time conversations at scale. Think fast food ordering, booking appointments, or inquiring about the latest deals at a car dealership. These tasks are relevant to just about everyone on the planet, and they require fast, efficient text-to-speech conversion for an AI agent to fulfill them. While voice quality is still important to keep users engaged, quality here is more about the naturalness of the flow of conversation and less about sounding like Morgan Freeman.\",\n \"start_word\": 535,\n \"end_word\": 622,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.2202893942594528\n },\n {\n \"text\": \"But the primary focus for most customers in this category is on improving customer outcomes, meaning speed and efficiency are must-haves for ensuring these everyday exchanges are smooth and reliable at high volume. \\\"Deepgram showed me less than 200ms latency today. That's the fastest text-to-speech I’ve ever seen.\",\n \"start_word\": 623,\n \"end_word\": 670,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4590202569961548\n },\n {\n \"text\": \"And our customers would be more than satisfied with the conversation quality.\\\" Jordan Dearsley, Co-founder at Vapi Although high production use cases seem to be well-served with UI-centric production tools, high throughput, real-time use cases still mostly rely on APIs provided by the major cloud providers.\",\n \"start_word\": 671,\n \"end_word\": 716,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.01252671144902706\n },\n {\n \"text\": \"And our customers have been telling us that they’ve been falling short, with insufficient quality for a good user experience, too much latency to make real-time use cases work, and costs too expensive to operate at scale.\",\n \"start_word\": 717,\n \"end_word\": 753,\n \"sentiment\": \"negative\",\n \"sentiment_score\": -0.49942296743392944\n },\n {\n \"text\": \"More human than human ---------- With Aura, we’ll give realistic voices to AI agents. Our goal is to craft text-to-speech capabilities that mirror natural human conversations, including timely responses, the incorporation of natural speech fillers like 'um' and 'uh' during contemplation, and the modulation of tone and emotion according to the conversational context. We aim to incorporate laughter and other speech nuances as well. Furthermore, we are dedicated to tailoring these voices to their specific applications, ensuring they remain composed and articulate, particularly in enunciating account numbers and business names with precision. \\\"I don’t really consider Azure and the other guys anymore because the voices sound so robotic.\\\" Jordan Dearsley, Co-founder at Vapi In blind evaluation trials conducted for benchmarking, early versions of Aura have consistently been rated as sounding more human than prominent alternatives, even outranking human speakers for various audio clips more often than not on average.\",\n \"start_word\": 754,\n \"end_word\": 902,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.10511736571788788\n },\n {\n \"text\": \"We were pleasantly surprised by these results (stay tuned for a future post containing comprehensive benchmarks for speed and quality soon!), so much so that we’re accelerating our development timeline and publicly announcing today’s waitlist expansion.\",\n \"start_word\": 903,\n \"end_word\": 938,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4318973124027252\n },\n {\n \"text\": \"Here are some sample clips generated by one of the earliest iterations of Aura.\",\n \"start_word\": 939,\n \"end_word\": 952,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.1747044026851654\n },\n {\n \"text\": \"The quality and overall performance will continue to improve with additional model training and refinement.\",\n \"start_word\": 953,\n \"end_word\": 967,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.3693663775920868\n },\n {\n \"text\": \"We encourage you to give them a listen and note the naturalness of their cadence, rhythm, and tone in the flow of conversation with another human. Our Approach ---------- For nearly a decade, we’ve worked tirelessly to advance the art of the possible in speech recognition and spoken language understanding. Along the way, we’ve transcribed trillions of spoken words into highly accurate transcriptions.\",\n \"start_word\": 968,\n \"end_word\": 1030,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.2442323863506317\n },\n {\n \"text\": \"Our model research team has developed novel transformer architectures equipped to deal with the nuances of conversational audio–across different languages, accents, and dialects, while handling disfluencies and the changing rhythms, tones, cadences, and inflections that occur in natural, back-and-forth conversations. And all the while, we’ve purposefully built our models under limited constraints to optimize their speed and efficiency. With support for dozens of languages and custom model training, our technical team has trained and deployed thousands of speech AI models (more than anybody else) which we operate and manage for our customers each day using our own computing infrastructure. We also have our own in-house data labeling and data ops team with years of experience building bespoke workflows to record, store, and transfer vast amounts of audio in order to label it and continuously grow our bank of high-quality data (millions of hours and counting) used in our model training. These combined experiences have made us experts in processing and modeling speech audio, especially in support of streaming use cases with our real-time STT models. Our customers have been asking if we could apply the same approach for TTS, and we can. So what can you expect from Aura?\",\n \"start_word\": 1031,\n \"end_word\": 1229,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.18155942857265472\n },\n {\n \"text\": \"Delivering the same market-leading value and performance as Nova-2 does for STT. Aura is built to be the panacea for speed, quality, and efficiency–the fastest of the high-quality options, and the best quality of the fast ones. And that’s really what end users need and what our customers have been asking us to build. \\\"Deepgram is a valued partner, providing our customers with high throughput speech-to-text that delivers unrivaled performance without tradeoffs between quality, speed, and cost.\",\n \"start_word\": 1230,\n \"end_word\": 1306,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.4960947036743164\n },\n {\n \"text\": \"We're excited to see Deepgram extend their speech AI platform and bring this approach to the text-to-speech market.\\\" - Richard Dumas, VP AI Product Strategy at Five9 What's Next ---------- As we’ve discussed, scaled voice agents are a high throughput use case, and we believe their success will ultimately depend on a unified approach to audio, one that strikes the right balance between natural voice quality, responsiveness, and cost-efficiency. And with Aura, we’re just getting started.\",\n \"start_word\": 1307,\n \"end_word\": 1382,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.2990237772464752\n },\n {\n \"text\": \"We’re looking forward to continuing to work with customers like Asurion and partners like Five9 across speech-to-text AND text-to-speech as we help them define the future of AI agents, and we invite you to join us on this journey.\",\n \"start_word\": 1383,\n \"end_word\": 1421,\n \"sentiment\": \"positive\",\n \"sentiment_score\": 0.5466783046722412\n },\n {\n \"text\": \"We expect to release generally early next year, but if you’re working on any real-time AI agent use cases, join our waitlist today to jumpstart your development in production as we continue to refine our model and API features with your direct feedback.\",\n \"start_word\": 1422,\n \"end_word\": 1464,\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.32348108291625977\n }\n ],\n \"average\": {\n \"sentiment\": \"neutral\",\n \"sentiment_score\": 0.2622680365893686\n }\n }\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"err_code\": \"INVALID_QUERY_PARAMETER\",\n \"err_msg\": \"Failed to deserialize query parameters: missing field `language`\",\n \"request_id\": \"93e5876e-422b-4254-a128-18691012864f\"\n}","language":"json","status":400}]},"params":[{"name":"custom_topic","type":"string","enumValues":"","default":"","desc":"A custom topic you want the model to detect within your input audio if present. Submit up to one hundred topics. <a href=\"/docs/text-topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd44cea9f372003ee74adc"},{"name":"custom_topic_mode","type":"enum","enumValues":"extended, strict","default":"","desc":"When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param. Default: `extended` <a href=\"/docs/text-topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd44cea9f372003ee74adb"},{"name":"intents","type":"boolean","enumValues":"","default":"","desc":"Recognizes speaker intent throughout an entire input text. Returns a list of text segments and the intents found within each segment. <a href=\"/docs/text-intention-recognition\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd24d930dcf50023f5eefe"},{"name":"language","type":"string","enumValues":"en","default":"en","desc":"Required: `en`. The language of your input text. (Only English language is supported at this time)","required":false,"in":"query","ref":"","_id":"65bd3d9dd37b09005b80e606"},{"name":"sentiment","type":"boolean","enumValues":"","default":"","desc":"Recognizes the sentiment of the entire input text and detects a shift in sentiment throughout. Returns a list of text segments and the sentiment found within each segment. <a href=\"/docs/text-sentiment-analysis\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd3d9dd37b09005b80e60c"},{"name":"summarize","type":"boolean","enumValues":"","default":"","desc":"Provides a brief summary of the input text. <a href=\"/docs/text-summarization\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd3d9dd37b09005b80e60b"},{"name":"topics","type":"boolean","enumValues":"","default":"","desc":"Detects topics throughout an entire input text. Returns a list of text segments and the topics found within each segment. <a href=\"/docs/text-topic-detection\">Learn More</a>","required":false,"in":"query","ref":"","_id":"65bd3d9dd37b09005b80e60a"},{"name":"text","type":"string","enumValues":"","default":"","desc":"Basic text request (when sending the text as a string or text/plain)","required":false,"in":"body","ref":"","_id":"65bd3d9dd37b09005b80e609"},{"name":"url","type":"string","enumValues":"","default":"","desc":"Basic URL request (when sending the text as a hosted URL)","required":false,"in":"body","ref":"","_id":"65bd3d9dd37b09005b80e608"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"65bd3d9dd37b09005b80e607"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Analyze Text","icon":"","type":"endpoint","slug":"analyze-text","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"65bd1459a8f9cd0063a614a1","createdAt":"2024-02-02T17:22:33.149Z","isBodyEmpty":true,"children":[]}]},{"_id":"66ccde4f4db0a00019aea808","title":"VOICE AGENT API","slug":"voice-agent-api","order":5,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2024-08-26T19:58:07.056Z","__v":0,"pages":[{"_id":"66ccde967aa407004302aa7b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Build a Voice Agent","icon":"","type":"basic","slug":"build-a-voice-agent","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"configure-a-voice-agent","category":"66ccde4f4db0a00019aea808","createdAt":"2024-08-26T19:59:18.371Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"671694a7bd44f5004ced168a","title":"MANAGEMENT API","slug":"management-api","order":6,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2024-10-21T17:51:35.282Z","__v":0,"pages":[{"_id":"66bd1a789fa68e005bac22e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Models","icon":"","type":"basic","slug":"models","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2024-08-14T20:58:32.939Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"66bd1b3c09e82f0054f2171e","api":{"method":"get","url":"/models","auth":"required","results":{"codes":[{"name":"","code":"{\n \"stt\": [\n {\n \"name\": \"general\",\n \"canonical_name\": \"enhanced-general\",\n \"architecture\": \"polaris\",\n \"languages\": [\n \"en\",\n \"en-us\"\n ],\n \"version\": \"2022-05-18.1\",\n \"uuid\": \"c7226e9e-ae1c-4057-ae2a-a71a6b0dc588\",\n \"batch\": true,\n \"streaming\": true,\n \"formatted_output\": false\n }\n ],\n \"tts\": [\n {\n \"name\": \"angus\",\n \"canonical_name\": \"aura-angus-en\",\n \"architecture\": \"aura\",\n \"languages\": [\n \"en\"\n ],\n \"version\": \"2024-07-30.0\",\n \"uuid\": \"eed36e9e-37aa-40a3-91fa-a2911e73a5da\",\n \"metadata\": {\n \"accent\": \"Irish\",\n \"color\": \"#BA80F5\",\n \"image\": \"https://static.deepgram.com/examples/avatars/angus.jpg\",\n \"sample\": \"https://static.deepgram.com/examples/voices/angus.wav\",\n \"tags\": [\n \"masculine\"\n ]\n }\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"include_outdated","type":"boolean","enumValues":"","default":"false","desc":"returns non-latest versions of models.","required":false,"in":"query","ref":"","_id":"66bd1b3c09e82f0054f2171f"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Get Models","icon":"","type":"endpoint","slug":"get-models","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66bd1a789fa68e005bac22e9","category":"671694a7bd44f5004ced168a","createdAt":"2024-08-14T21:01:48.429Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66bd1f4dcfccba003a7db8bd","api":{"method":"get","url":"/models/{model_id}","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"model_uuid","type":"string","enumValues":"","default":"","desc":"The specific UUID of the model.","required":false,"in":"path","ref":"","_id":"66bd1f4dcfccba003a7db8be"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Get Model","icon":"","type":"endpoint","slug":"get-model","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"66bd1a789fa68e005bac22e9","category":"671694a7bd44f5004ced168a","createdAt":"2024-08-14T21:19:09.427Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"643ed29218e0270057be387a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Projects","icon":"","type":"basic","slug":"projects","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T17:25:38.154Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643ed2ad69a1280fcd9ef95f","api":{"method":"get","url":"/projects","auth":"required","params":[],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\"projects\":[{\"project_id\":\"2c10a921-39ba-4965-9a0d-a0c9f1dc71b8\",\"name\":\"developers@deepgram.com's Project\"}]}","language":"json","status":200},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403}]}},"title":"Get Projects","icon":"","type":"endpoint","slug":"get-projects","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T17:26:05.408Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef280af85a3001154eebb","api":{"method":"get","url":"/projects/{project_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve information. (UUID)","required":false,"in":"path","ref":"","_id":"643ef2b96a6788000b111408"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Number of results to return per page. Default 10. Range [1,100]","required":false,"in":"query","ref":"","_id":"6595f5188d4a70004c0f377d"},{"name":"start","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM","required":false,"in":"query","ref":"","_id":"6595f5188d4a70004c0f377c"},{"name":"end","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM.","required":false,"in":"query","ref":"","_id":"6595f5188d4a70004c0f377b"},{"name":"page","type":"int","enumValues":"","default":"","desc":"Navigate and return the results to retrieve specific portions of information of the response.","required":false,"in":"query","ref":"","_id":"6595f5188d4a70004c0f377a"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"project_id\": \"uuid\",\n \"name\": \"string\",\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404},{"code":"UUID parsing failed: invalid length: expected length 32 for simple format, found X","language":"text","status":404},{"code":"","language":"json","status":400}]}},"title":"Get Project","icon":"","type":"endpoint","slug":"get-project","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:41:52.052Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef2fd4885e600663bea7b","api":{"method":"patch","url":"/projects/{project_id}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"message\": \"Successfully updated project info.\"\n}","language":"json","status":200},{"name":"","code":"{\n \"category\": \"INSUFFICIENT_PERMISSIONS\",\n \"message\": \"Your account does not have the required scope to perform that action for this project.\",\n \"details\": \"Check that your account has the 'project:write:settings' scope for this project.\",\n \"request_id\": \"003d93f1-648c-46cc-82c4-00eed1a7d4e2\"\n}","language":"json","status":403},{"code":"{\n \"category\": \"INVALID_JSON\",\n \"message\": \"Invalid JSON submitted.\",\n \"details\": \"Json deserialize error: EOF while parsing a value at line 1 column 0\",\n \"request_id\": \"8bd53f38-9db5-48a1-a24c-921e81a5ecd4\"\n}","language":"json","status":400},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404},{"code":"UUID parsing failed: invalid length: expected length 32 for simple format, found X","language":"text","status":404}]},"params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project that you want to update. (UUID)","required":false,"in":"path","ref":"","_id":"643ef2fd4885e600663bea7c"},{"name":"name","type":"string","enumValues":"","default":"","desc":"Update the project name.","required":false,"in":"body","ref":"","_id":"6478ae8356a60d1469f31268"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Update Project","icon":"","type":"endpoint","slug":"update-project","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:43:57.505Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef30c2c11650056d4de4d","api":{"method":"delete","url":"/projects/{project_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project that you want to delete. (UUID)","required":false,"in":"path","ref":"","_id":"643ef34364f13a002ca80608"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"category\": \"INVALID_JSON\",\n \"message\": \"Invalid JSON submitted.\",\n \"details\": \"Json deserialize error: EOF while parsing a value at line 1 column 0\",\n \"request_id\": \"8bd53f38-9db5-48a1-a24c-921e81a5ecd4\"\n}","language":"json","status":400},{"name":"","code":"{\"category\":\"INSUFFICIENT_PERMISSIONS\",\"message\":\"Your account does not have the required scope to perform that action for this project.\",\"details\":\"Check that your account has the 'project:write:destroy' scope for this project.\",\"request_id\":\"28cc6f81-7259-48c4-a19a-021a2ef6e47b\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404},{"code":"UUID parsing failed: invalid length: expected length 32 for simple format, found X","language":"text","status":404},{"code":"","language":"text","status":200}]}},"title":"Delete Project","icon":"","type":"endpoint","slug":"delete-project","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:44:12.164Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66bd1c551dad6700136ab3ff","api":{"method":"get","url":"/projects/{project}/models","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"include_outdated","type":"boolean","enumValues":"","default":"false","desc":"returns non-latest versions of models.","required":false,"in":"query","ref":"","_id":"66bd1c551dad6700136ab400"},{"name":"project_id","type":"string","enumValues":"","default":"","desc":"The specific UUID of the project.","required":false,"in":"path","ref":"","_id":"66bd1e92d4ced500271cd761"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Get Project Models","icon":"","type":"endpoint","slug":"get-project-models","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2024-08-14T21:06:29.009Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66bd20f9d34bac005d03278f","api":{"method":"get","url":"/projects/{project}/models/{model_id}","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"The specific UUID of the project.","required":false,"in":"path","ref":"","_id":"66bd20f9d34bac005d032791"},{"name":"model_id","type":"string","enumValues":"","default":"","desc":"The specific UUID of the model.","required":false,"in":"path","ref":"","_id":"66bd20f9d34bac005d032790"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Get Project Model","icon":"","type":"endpoint","slug":"get-project-model","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-project-models-1","parentDoc":"643ed29218e0270057be387a","category":"671694a7bd44f5004ced168a","createdAt":"2024-08-14T21:26:17.431Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"643daf2c2f5eb1003a23d1b8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Keys","icon":"","type":"basic","slug":"keys","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T20:42:20.180Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643db02a339505005ef7def6","api":{"method":"get","url":"/projects/{project_id}/keys","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db055808a90000a69f1bf"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\"api_keys\":[{\"member\":{\"member_id\":\"c74f9a10-ea40-4585-951e-88e63c35108f\",\"email\":\"devrel@deepgram.com\",\"first_name\":\"Deepgram\",\"last_name\":\"Team\"},\"api_key\":{\"api_key_id\":\"17c8886a-b58f-4c15-a7eb-9e52f2cf26ce\",\"comment\":\"Member API key\",\"scopes\":[\"member\"],\"tags\":[\"user\"],\"created\":\"2021-06-01T14:03:35.815832Z\"}},{\"member\":{\"member_id\":\"b74f9a00-ea40-4585-951e-88e63c35108f\",\"email\":\"devrel@deepgram.com\",\"first_name\":\"Scott\",\"last_name\":\"Stephenson\"},\"api_key\":{\"api_key_id\":\"15f6022a-d188-4317-a3dd-4340fdeddb75\",\"comment\":\"Management API key\",\"scopes\":[\"owner\"],\"created\":\"2021-05-30T12:24:33.564224Z\"}}]}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Get Keys","icon":"","type":"endpoint","slug":"list-keys","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643daf2c2f5eb1003a23d1b8","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T20:46:34.345Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643db063efd395002f3714f0","api":{"method":"get","url":"/projects/{project_id}/keys/{key_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db0ceec0eb5006dc2a28d"},{"name":"key_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the key that you want to retrieve. (UUID)","required":false,"in":"path","ref":"","_id":"643db0ceec0eb5006dc2a28c"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"member\": {\n \"member_id\": \"b74f9a00-ea40-4585-951e-88e63c35108f\",\n \"email\": \"devrel@deepgram.com\",\n \"first_name\": \"Deepgram\",\n \"last_name\": \"Team\"\n },\n \"api_key\": {\n \"api_key_id\": \"17c8886a-b58f-4c15-a7eb-9e52f2cf26ce\",\n \"comment\": \"Member API key\",\n \"scopes\": [\n \"member\"\n ],\n \"tags\": [\n \"user\"\n ],\n \"created\": \"2021-06-01T14:03:35.815832Z\"\n }\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Get Key","icon":"","type":"endpoint","slug":"get-key","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643daf2c2f5eb1003a23d1b8","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T20:47:31.434Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643db7231650b5004595d3aa","api":{"method":"post","url":"/projects/{project_id}/keys","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to create a key.(UUID)","required":false,"in":"path","ref":"","_id":"643eb9bb32ad9a166ef0e016"},{"name":"comment","type":"string","enumValues":"","default":"","desc":"Comments associated with the key you would like to create. Must be between 1 and 128 characters long, not including whitespace.","required":true,"in":"body","ref":"","_id":"643ece172f5eb1003a3a8217"},{"name":"scopes","type":"array_string","enumValues":"","default":"","desc":"Scopes for the key you would like to create.","required":true,"in":"body","ref":"","_id":"643ece172f5eb1003a3a8216"},{"name":"tags","type":"array_string","enumValues":"","default":"","desc":"Tags associated with the key you would like to create.","required":false,"in":"body","ref":"","_id":"643ece172f5eb1003a3a8215"},{"name":"expiration_date","type":"datetime","enumValues":"","default":"","desc":"<p>Date on which the key you would like to create should expire.</p><p>For each key, you may specify either an <strong><code>expiration_date</strong></code> or a <strong><code>time_to_live_in_seconds</strong></code>, but not both.</p>","required":false,"in":"body","ref":"","_id":"643ece172f5eb1003a3a8214"},{"name":"time_to_live_in_seconds","type":"int","enumValues":"","default":"","desc":"<p>Length of time (in seconds) during which the key you would like to create will remain valid.</p> <p>For each key, you may specify either an <strong><code>expiration_date</strong></code> or a <strong><code>time_to_live_in_seconds<strong><code>, but not both.</p>","required":false,"in":"body","ref":"","_id":"643ece172f5eb1003a3a8213"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"api_key_id\": \"3b20202-2b000-4901-b7ff-10101011\",\n \"key\": \"10101011010110101010101\",\n \"comment\": \"My test API Key\",\n \"scopes\": [\n \"member\"\n ],\n \"tags\": [\n \"tag-1\"\n ],\n \"created\": \"2024-10-09T21:30:09.641010Z\",\n \"expiration_date\": \"2024-10-10T00:00:00Z\"\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404},{"code":"{\n \"api_key_id\": \"b6c318f0-bc94-40b3-83a9-7f6898cd5500\",\n \"key\": \"1bc4a5e63f8425c9fd102539739923204243b9ce\",\n \"comment\": \"Test On-prem API Key with curl\",\n \"scopes\": [\n \"member\",\n \"onprem:product:api\",\n \"onprem:product:engine\",\n \"onprem:product:license-proxy\"\n ],\n \"created\": \"2023-06-27T16:59:46.572660Z\"\n}","language":"json","status":200,"name":"On-prem API key example response"}]}},"title":"Create Key","icon":"","type":"endpoint","slug":"create-key","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643daf2c2f5eb1003a23d1b8","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T21:16:19.249Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ed1d8123d7e00255f8bae","api":{"method":"delete","url":"/projects/{project_id}/keys/{key_id}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"message\": \"string\"\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]},"params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project that contains the key that you want to delete. (UUID)","required":false,"in":"path","ref":"","_id":"643ed1d8123d7e00255f8bb0"},{"name":"key_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the key that you want to delete. (UUID)","required":false,"in":"path","ref":"","_id":"643ed1d8123d7e00255f8baf"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Delete Key","icon":"","type":"endpoint","slug":"delete-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643daf2c2f5eb1003a23d1b8","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T17:22:32.899Z","isBodyEmpty":false,"children":[]}]},{"_id":"643d87b9f988be141b814d00","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Members","icon":"","type":"basic","slug":"members","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T17:54:01.133Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643d87c92541a9003ddc91dd","api":{"method":"get","url":"/projects/{project_id}/members","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to get members. (UUID)","required":false,"in":"path","ref":"","_id":"643d88c804c93610ed782451"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"members\": [\n {\n \"member_id\": \"uuid\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"scopes\": [\n \"string\"\n ],\n \"email\": \"string\"\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"err_code\": \"PROJECT_NOT_FOUND\",\n \"err_msg\": \"Project not found.\"\n}","language":"json","status":404}]}},"title":"Get Members","icon":"","type":"endpoint","slug":"get-members","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T17:54:17.146Z","parentDoc":"643d87b9f988be141b814d00","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643dae684fcf0f007a00f689","api":{"method":"delete","url":"/projects/{project_id}/members/{member_id}","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"err_code\": \"PROJECT_NOT_FOUND\",\n \"err_msg\": \"Project not found.\"\n}","language":"json","status":404}]},"params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to get members. (UUID)","required":false,"in":"path","ref":"","_id":"643dae684fcf0f007a00f68b"},{"name":"member_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the account that you want to remove. (UUID)","required":false,"in":"path","ref":"","_id":"643dae684fcf0f007a00f68a"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Remove Member","icon":"","type":"endpoint","slug":"remove-member","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643d87b9f988be141b814d00","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-17T20:39:04.230Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"644a79f3040080000d1206db","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Scopes","icon":"","type":"basic","slug":"scopes","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-27T13:34:43.340Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643ef3980a13af003e1fa128","api":{"method":"get","url":"/projects/{project_id}/members/{member_id}/scopes","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Identifier of the project that contains the member for whom you want to get scopes. (UUID)","required":false,"in":"path","ref":"","_id":"643ef3df12f3e00073cdbf54"},{"name":"member_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the member for whom you want to get scopes.","required":false,"in":"path","ref":"","_id":"643ef3df12f3e00073cdbf53"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"scopes\": [\"string\"]\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Get Member Scopes","icon":"","type":"endpoint","slug":"get-member-scopes","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a79f3040080000d1206db","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:46:32.850Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef3f4ab9204007644d5ce","api":{"method":"put","url":"/projects/{project_id}/members/{member_id}/scopes","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project that contains the specified member and scope that you want to update. (UUID)","required":false,"in":"path","ref":"","_id":"643ef4587e4e0e001171ccde"},{"name":"member_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the member for whom you want to update the scope. (UUID)","required":false,"in":"path","ref":"","_id":"643ef4587e4e0e001171ccdd"},{"name":"scope","type":"string","enumValues":"","default":"","desc":"Scope for the specified member and project.","required":false,"in":"body","ref":"","_id":"643ef4587e4e0e001171ccdc"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"message\": \"string\"\n}","language":"json","status":200},{"name":"","code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Update Scope","icon":"","type":"endpoint","slug":"update-scope","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"644a79f3040080000d1206db","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:48:04.235Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"643ef4900c6a15005e17cdd3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Invitations","icon":"","type":"basic","slug":"invitations","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:50:40.183Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"644e282e11625d000be7aabb","api":{"method":"get","url":"/projects/{project_id}/invites","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to list invites. (UUID)","required":false,"in":"path","ref":"","_id":"643d88c804c93610ed782451"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"invites\": [\n {\n \"email\": \"string\",\n \"scope\": \"string\"\n }\n ]\n}","language":"json","status":200},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404},{"code":"User does not have sufficient permissions.","language":"text","status":401}]}},"title":"Get Invites","icon":"","type":"endpoint","slug":"list-invites","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-members-copy","parentDoc":"643ef4900c6a15005e17cdd3","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-30T08:34:54.446Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"644e29f24e619b0060119c14","api":{"method":"post","url":"/projects/{project_id}/invites","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to send an invite for. (UUID)","required":false,"in":"path","ref":"","_id":"643d88c804c93610ed782451"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Email to invite to the project","required":true,"in":"body","ref":"","_id":"644e2da8f1a906073b07a9e9"},{"name":"scope","type":"string","enumValues":"","default":"","desc":"Scope to give the user","required":true,"in":"body","ref":"","_id":"644e2da8f1a906073b07a9e8"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl -X POST \"https://api.deepgram.com/v1/projects/{project_id}/invites\" \\\n-H \"Authorization: Token {your_api_key}\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"email\": \"newuser@example.com\",\n \"scope\": \"member\"\n}'","language":"curl"},{"code":"from deepgram import DeepgramClient, InviteOptions\n\n# Create a Deepgram client using the API key\ndeepgram = DeepgramClient()\n\n# Replace with your actual project ID\nproject_id = \"your_project_id\"\n\n# Configure invite options\noptions = InviteOptions(email=\"newuser@example.com\", scope=\"member\")\n\n# Send the invite\ntry:\n response = deepgram.manage.v(\"1\").send_invite_options(project_id, options)\n print(f\"SendInvite() - Msg: {response.message}\")\nexcept Exception as e:\n print(f\"Exception while sending invite: {e}\")\n","language":"python","name":"SDK"},{"code":"import requests\n\n# Replace these with your actual project ID and API key\nproject_id = \"your_project_id\"\napi_key = \"your_api_key\"\n\n# API endpoint\nurl = f\"https://api.deepgram.com/v1/projects/{project_id}/invites\"\n\n# Request headers\nheaders = {\n \"Authorization\": f\"Token {api_key}\",\n \"Content-Type\": \"application/json\"\n}\n\n# Request payload\ndata = {\n \"email\": \"newuser@example.com\", # Replace with the invitee's email\n \"scope\": \"member\" # Replace with the desired scope: 'member', 'admin', or 'owner'\n}\n\n# Make the POST request\nresponse = requests.post(url, headers=headers, json=data)\n\n# Handle the response\nif response.status_code == 200 or response.status_code == 201:\n print(\"Invitation sent successfully!\")\n print(response.json()) # Optional: Print the response JSON for verification\nelse:\n print(\"Failed to send invitation.\")\n print(f\"Status Code: {response.status_code}\")\n print(f\"Response: {response.text}\")\n","language":"python","name":"Requests"}]},"results":{"codes":[{"name":"","code":"{\n \"message\": \"Sent an invite!\"\n}","language":"json","status":200},{"code":"{\n \"err_code\": \"PROJECT_NOT_FOUND\",\n \"err_msg\": \"Project not found.\"\n}","language":"json","status":404},{"code":"User does not have sufficient permissions.","language":"text","status":401},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"Invalid request: scope must be either 'member', 'admin' or 'owner'.","language":"text","status":400}]}},"title":"Send Invite","icon":"","type":"endpoint","slug":"send-invites","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-invites-copy","parentDoc":"643ef4900c6a15005e17cdd3","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-30T08:42:26.554Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"644e2ff8b714090057f197f8","api":{"method":"delete","url":"/projects/{project_id}/invites/{email}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project from which you want to remove the authenticated account. (UUID)","required":false,"in":"path","ref":"","_id":"643ef50ae5926a0057a397b4"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Email of the invite you want to delete","required":false,"in":"path","ref":"","_id":"644e304209776f004394fee6"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"message\": \"Successfully deleted the invite.\"\n}","language":"json","status":200},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"err_code\": \"PROJECT_NOT_FOUND\",\n \"err_msg\": \"Project not found.\"\n}","language":"text","status":404},{"code":"User does not have sufficient permissions.","language":"text","status":401},{"code":"Invalid request: scope must be either 'member', 'admin' or 'owner'.","language":"text","status":400,"name":null}]}},"title":"Delete Invite","icon":"","type":"endpoint","slug":"delete-invite","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"leave-project-copy","parentDoc":"643ef4900c6a15005e17cdd3","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-30T09:08:08.310Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef4af712fe3000bb596e1","api":{"method":"delete","url":"/projects/{project_id}/leave","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project from which you want to remove the authenticated account. (UUID)","required":false,"in":"path","ref":"","_id":"643ef50ae5926a0057a397b4"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \t\"message\": \"Successfully removed account from project.\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"err_code\": \"PROJECT_NOT_FOUND\",\n \"err_msg\": \"Project not found.\"\n}","language":"text","status":404},{"code":"User does not have sufficient permissions.","language":"text","status":401}]}},"title":"Leave Project","icon":"","type":"endpoint","slug":"leave-project","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef4900c6a15005e17cdd3","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:51:11.201Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"643ef5186a6788000b1141e9","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Usage","icon":"","type":"basic","slug":"usage","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:52:56.612Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643ef535901c06006fcf21c1","api":{"method":"get","url":"/projects/{project_id}/requests","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve requests. (UUID)","required":false,"in":"path","ref":"","_id":"643ef5c669e66300420e6e1f"},{"name":"start","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM.","required":false,"in":"query","ref":"","_id":"643ef5c669e66300420e6e1e"},{"name":"end","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM.","required":false,"in":"query","ref":"","_id":"643ef5c669e66300420e6e1d"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Number of results to return per page. Default 10. Range [1,100].","required":false,"in":"query","ref":"","_id":"643ef5c669e66300420e6e1c"},{"name":"page","type":"int","enumValues":"","default":"","desc":"Navigate and return the results to retrieve specific portions of information of the response.","required":false,"in":"query","ref":"","_id":"6595f574dd9cd9002ac2c0c5"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"page\": 0,\n\t\"limit\": 0,\n\t\"requests\": [\n\t\t{\n\t\t\t\"request_id\": \"uuid\",\n \"project_uuid\": \"uuid\",\n\t\t\t\"created\": \"YYYY-MM-DDThh:mm:ss.sTZD\",\n\t\t\t\"path\": \"string\",\n\t\t\t\"api_key_id\": \"uuid\",\n\t\t\t\"response\": {\n\t\t\t\t\"details\": {\n\t\t\t\t\t\"usd\": 0,\n\t\t\t\t\t\"duration\": 0,\n\t\t\t\t\t\"total_audio\": 0,\n\t\t\t\t\t\"channels\": 0,\n\t\t\t\t\t\"streams\": 0,\n\t\t\t\t\t\"models\": [\"string\"],\n\t\t\t\t\t\"method\": \"string\",\n\t\t\t\t\t\"tags\": [\"string\"],\n\t\t\t\t\t\"features\": [\"string\"],\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"alternatives\": 0,\n\t\t\t\t\t\t\"diarize\": true,\n\t\t\t\t\t\t\"keywords\": [\"string\"],\n\t\t\t\t\t\t\"language\": \"string\",\n\t\t\t\t\t\t\"model\": \"string\",\n\t\t\t\t\t\t\"multichannel\": true,\n\t\t\t\t\t\t\"ner\": true,\n\t\t\t\t\t\t\"numerals\": true,\n\t\t\t\t\t\t\"profanity_filter\": false,\n\t\t\t\t\t\t\"punctuate\": true,\n\t\t\t\t\t\t\"redact\": [\"string\"],\n\t\t\t\t\t\t\"search\": [\"string\"],\n\t\t\t\t\t\t\"utterances\": true\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"code\": 0,\n\t\t\t\t\"completed\": \"YYYY-MM-DDThh:mm:ss.sTZD\",\n \"deployment\": \"hosted\"\n\t\t\t},\n\t\t\t\"callback\": {\n\t\t\t\t\"attempts\": 0,\n\t\t\t\t\"code\": 0,\n\t\t\t\t\"completed\": \"YYYY-MM-DDThh:mm:ss.sTZD\"\n\t\t\t}\n\t\t}\n\t]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"","language":"text","status":401},{"code":"","language":"text","status":404}]}},"title":"Get All Requests","icon":"","type":"endpoint","slug":"get-all-requests","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef5186a6788000b1141e9","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:53:25.321Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef5e6021f8e0012e46ad5","api":{"method":"get","url":"/projects/{project_id}/requests/{request_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve the specified request. (UUID)","required":false,"in":"path","ref":"","_id":"643ef62f85750c001f4e9b67"},{"name":"request_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the request that you want to retrieve. (UUID)","required":false,"in":"path","ref":"","_id":"643ef62f85750c001f4e9b66"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"request_id\": \"uuid\",\n\t\"created\": \"YYYY-MM-DDThh:mm:ss.sTZD\",\n \"project_uuid\":\"uuid\",\n\t\"path\": \"string\",\n\t\"api_key_id\": \"uuid\",\n\t\"response\": {\n\t\t\"details\": {\n\t\t\t\"usd\": 0,\n\t\t\t\"duration\": 0,\n\t\t\t\"total_audio\": 0,\n\t\t\t\"channels\": 0,\n\t\t\t\"streams\": 0,\n\t\t\t\"models\": [\"string\"],\n\t\t\t\"method\": \"string\",\n\t\t\t\"tags\": [\"string\"],\n\t\t\t\"features\": [\"string\"],\n\t\t\t\"config\": {\n\t\t\t\t\"alternatives\": 0,\n\t\t\t\t\"callback\": \"string\",\n\t\t\t\t\"diarize\": true,\n\t\t\t\t\"keywords\": [\"string\"],\n\t\t\t\t\"language\": \"string\",\n\t\t\t\t\"model\": \"string\",\n\t\t\t\t\"multichannel\": true,\n\t\t\t\t\"ner\": true,\n\t\t\t\t\"numerals\": true,\n\t\t\t\t\"profanity_filter\": true,\n\t\t\t\t\"punctuate\": true,\n\t\t\t\t\"redact\": [\"string\"],\n\t\t\t\t\"search\": [\"string\"],\n\t\t\t\t\"utterances\": true\n\t\t\t}\n\t\t},\n\t\t\"code\": 0,\n\t\t\"completed\": \"YYYY-MM-DDThh:mm:ss.sTZD\",\n \"deployment\": \"hosted\"\n\t},\n\t\"callback\": {\n\t\t\"attempts\": 0,\n\t\t\"code\": 0,\n\t\t\"completed\": \"YYYY-MM-DDThh:mm:ss.sTZD\"\n\t}\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"","language":"text","status":401},{"code":"","language":"text","status":404}]}},"title":"Get Request","icon":"","type":"endpoint","slug":"get-request","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef5186a6788000b1141e9","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T19:56:22.257Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64531e758565dd01eb6ac80c","api":{"method":"get","url":"/projects/{project_id}/usage","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve the specified request. (UUID)","required":false,"in":"path","ref":"","_id":"64531f09c0326e04fc4f4db9"},{"name":"start","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"Start date of the requested date range. Format accepted is YYYY-MM-DD.","required":false,"in":"query","ref":"","_id":"6453212bd98df2027712aeaa"},{"name":"end","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"End date of the requested date range. Format accepted is YYYY-MM-DD.","required":false,"in":"query","ref":"","_id":"645325279fe45a003941ab75"},{"name":"accessor","type":"string","enumValues":"","default":"","desc":"Limits results to the given API key. To include multiple API Keys, send multiple instances in query string (e.g., accessor=2ed1...cfa4e&accessor=1dc0...bez3d).","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e929"},{"name":"bit_rate","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `bit_rate` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded9"},{"name":"callback","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `callback` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded8"},{"name":"custom_topic","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `custom_topics` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded7"},{"name":"container","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `container` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded6"},{"name":"diarize","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `diarize` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91c"},{"name":"dication","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `dictation` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded4"},{"name":"deployment","type":"enum","enumValues":"hosted, onprem","default":"","desc":"Limits results to requests fulfilled in either Deepgram hosted cloud or your self-hosted (*onprem*) deployment environment. To include multiple values, send multiple instances in query string (e.g. deployment=hosted&deployment=onprem).","required":false,"in":"query","ref":"","_id":"6544ef0712d2db15823976e3"},{"name":"detect_topics","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `detect_topics` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91d"},{"name":"encoding","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `encoding` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded1"},{"name":"enpointing","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `endpointing` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2ded0"},{"name":"extra","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `extra` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2decf"},{"name":"filler_words","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `filler_words` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2dece"},{"name":"intents","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `intents` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2decd"},{"name":"interim_results","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `interim_results` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e924"},{"name":"keywords","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `keywords` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91e"},{"name":"language","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `language` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2deca"},{"name":"method","type":"enum","enumValues":"sync, async, streaming","default":"","desc":"Limits results to requests processed using the specified method. To include multiple methods, send multiple instances in query string (e.g., method=sync&method=streaming).","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e927"},{"name":"measurements","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `measurements` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2dec8"},{"name":"model","type":"string","enumValues":"","default":"","desc":"Limits results to requests run with the specified model UUID applied.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e926"},{"name":"multichannel","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `multichannel` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e925"},{"name":"numerals","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `numerals` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e918"},{"name":"paragraphs","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `paragraphs` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2dec4"},{"name":"profanity_filter","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `profanity_filter` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91f"},{"name":"punctuate","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `punctuate` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e923"},{"name":"redact","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `redact` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91a"},{"name":"replace","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `replace` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e920"},{"name":"sample_rate","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `sample_rate` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2debf"},{"name":"search","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `search` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e91b"},{"name":"sentiment","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `sentiment` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2debd"},{"name":"smart_format","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `smart_format` feature.","required":false,"in":"query","ref":"","_id":"6462ba690e0beb000b71169b"},{"name":"summarize","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `summarize` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2debb"},{"name":"tag","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests associated with the specified tag. To include multiple tags, send multiple instances in query string (e.g., tag=dev&tag=production)","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e928"},{"name":"utterances","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `utterances` feature.","required":false,"in":"query","ref":"","_id":"64532f330b0d8a006dd4e921"},{"name":"utt_split","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `utt_split` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2deb8"},{"name":"utterance_end_ms","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `utterance_end_ms` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2deb7"},{"name":"version","type":"string","enumValues":"","default":"","desc":"Limits results to requests that include the `version` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2deb6"},{"name":"vad_events","type":"boolean","enumValues":"","default":"","desc":"Limits results to requests that include the `vad_events` feature.","required":false,"in":"query","ref":"","_id":"671995790e25410019a2deb5"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"start\": \"2024-10-16\",\n \"end\": \"2024-10-23\",\n \"resolution\": {\n \"units\": \"day\",\n \"amount\": 1\n },\n \"results\": [\n {\n \"start\": \"2024-10-16\",\n \"end\": \"2024-10-16\",\n \"hours\": 1097.4274322222223,\n \"total_hours\": 1099.3888366666667,\n \"requests\": 425109,\n \"tokens\": {\n \"in\": 24770,\n \"out\": 7521\n },\n \"tts\": {\n \"characters\": 9004185,\n \"requests\": 231261\n }\n }\n ]\n}","language":"json","status":200},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"","language":"text","status":400},{"code":"","language":"text","status":401},{"code":"","language":"text","status":404}]}},"title":"Summarize Usage","icon":"","type":"endpoint","slug":"summarize-usage","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef5186a6788000b1141e9","category":"671694a7bd44f5004ced168a","createdAt":"2023-05-04T02:54:45.543Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"643ef7b8e5926a0057a3af29","api":{"method":"get","url":"/projects/{project_id}/usage/fields","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve fields. (UUID)","required":false,"in":"path","ref":"","_id":"643ef8339030f10025ce8974"},{"name":"start","type":"string","enumValues":"","default":"","desc":"Start date of the requested date range. Format is YYYY-MM-DD. If a full timestamp is given, it will be truncated to a day. Dates are UTC. Defaults to the date of your first request.","required":false,"in":"query","ref":"","_id":"643ef8339030f10025ce8973"},{"name":"end","type":"string","enumValues":"","default":"","desc":"End date of the requested date range. Format is YYYY-MM-DD. If a full timestamp is given, it will be truncated to a day. Dates are UTC. Defaults to the current date.","required":false,"in":"query","ref":"","_id":"643ef8339030f10025ce8972"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"tags\": [\"string\"],\n\t\"models\": [\n\t\t{\n\t\t\t\"name\": \"string\",\n\t\t\t\"language\": \"string\",\n\t\t\t\"version\": \"string\",\n\t\t\t\"model_id\": \"string\"\n\t\t}\n\t],\n\t\"processing_methods\": [\"string\"],\n\t\"languages\": [\"string\"],\n\t\"features\": [\"string\"]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403}]}},"title":"Get Fields","icon":"","type":"endpoint","slug":"get-fields","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef5186a6788000b1141e9","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T20:04:08.063Z","isBodyEmpty":false,"children":[]}]},{"_id":"643ef84f7ad4450037fcc52a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Billing","icon":"","type":"basic","slug":"billing","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T20:06:39.794Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643ef86a91ca3f00505623ca","api":{"method":"get","url":"/projects/{project_id}/balances","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Generates a list of outstanding balances for the specified project. To see balances, the authenticated account must be a project owner or administrator. (UUID)","required":false,"in":"path","ref":"","_id":"643ef89a0d62cf0065f28c8d"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"balances\": [\n\t\t{\n\t\t\t\"balance_id\": \"uuid\",\n\t\t\t\"amount\": 0,\n\t\t\t\"units\": \"string\",\n\t\t\t\"purchase_order_id\": \"string\"\n\t\t}\n\t]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"276f0b07-7b5d-417f-bfbb-71ef6509c793\"\n}","language":"json","status":404,"name":null}]}},"title":"Get Balances","icon":"","type":"endpoint","slug":"get-all-balances","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef84f7ad4450037fcc52a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T20:07:06.325Z","isBodyEmpty":false,"children":[]},{"_id":"643ef8c1640add01e6dac311","api":{"method":"get","url":"/projects/{project_id}/balances/{balance_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve the specified balance. (UUID)","required":false,"in":"path","ref":"","_id":"643ef8fe94ebbf002744064b"},{"name":"balance_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the balance that you want to retrieve. (UUID)","required":false,"in":"path","ref":"","_id":"643ef8fe94ebbf002744064a"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"balance_id\": \"uuid\",\n\t\"amount\": 0,\n\t\"units\": \"string\",\n\t\"purchase_order_id\": \"string\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"d1244c73-61a9-4c2f-9dfb-1cdf20ea621e\"\n}","language":"json","status":404}]}},"title":"Get Balance","icon":"","type":"endpoint","slug":"get-balance","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"643ef84f7ad4450037fcc52a","category":"671694a7bd44f5004ced168a","createdAt":"2023-04-18T20:08:33.608Z","isBodyEmpty":false,"children":[]}]},{"_id":"6733c5e1ee584b001f460d71","mdx":{},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Purchases","icon":"","type":"basic","slug":"purchases","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"671694a7bd44f5004ced168a","createdAt":"2024-11-12T21:17:21.094Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6733c5efee584b001f4610ff","mdx":{},"api":{"method":"get","url":"/projects/{project_id}/purchases","auth":"required","results":{"codes":[{"name":"","code":"{\n \"page\": 0,\n \"limit\": 10,\n \"orders\": [\n {\n \"order_id\": \"025e19ba-b6d9-4a04-9f99-4fe715aca5f1\",\n \"expiration\": \"2026-03-04T00:00:00Z\",\n \"created\": \"2023-02-21T21:13:40.014373Z\",\n \"amount\": 150.0,\n \"units\": \"usd\",\n \"order_type\": \"promotional\"\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400},{"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]},"params":[{"name":"project_id","type":"string","enumValues":"","default":"","desc":"Unique identifier of the project for which you want to retrieve information. (UUID)","required":false,"in":"path","ref":"","_id":"6733c790d2021e006579f2c3"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Number of results to return per page. Default 10. Range [1,100]","required":false,"in":"query","ref":"","_id":"6733c790d2021e006579f2c2"},{"name":"page","type":"int","enumValues":"","default":"","desc":"Navigate and return the results to retrieve specific portions of information of the response.","required":false,"in":"query","ref":"","_id":"6733c790d2021e006579f2bf"}],"examples":{"codes":[]},"apiSetting":"6424a4f5e2b5be000ad8feae"},"title":"Get Purchases","icon":"","type":"endpoint","slug":"get-purchases","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6733c5e1ee584b001f460d71","category":"671694a7bd44f5004ced168a","createdAt":"2024-11-12T21:17:35.059Z","isBodyEmpty":true,"children":[]}]}]},{"_id":"649fe034e9e70e0037d16c72","title":"SELF-HOSTED API","slug":"on-prem-api","order":7,"reference":true,"project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-07-01T08:13:40.178Z","__v":0,"pages":[{"_id":"649c91f4a708161851f9a980","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Credentials","icon":"","type":"basic","slug":"keys-copy","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"649fe034e9e70e0037d16c72","createdAt":"2023-06-28T20:03:00.139Z","isBodyEmpty":true,"children":[{"_id":"649c9223aaf01f000ae5f0b7","api":{"method":"get","url":"/projects/{project_id}/self-hosted/distribution/credentials","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"PROJECT_ID","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db055808a90000a69f1bf"},{"name":"Authorization","type":"string","enumValues":"","default":"Token SECRET","desc":"The secret from an API key as a `Token`.","required":false,"in":"header","ref":"","_id":"649cbbdb3af7030172a3132d"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl -X GET \\ 315ms  Wed Jun 28 17:12:47 2023\n -H 'Authorization: Token 4b08cefa12b80a6d16cb10c82fd8045e8f915087' \\\n https://api.deepgram.com/v1/projects/9f870faf-07a9-41b1-aa0d-de5030cb9bdc/self-hosted/distribution/credentials","language":"text","name":"curl"}]},"results":{"codes":[{"name":"","code":"{\n \"distribution_credentials\": [\n {\n \"member\": {\n \"member_id\": \"3376abcd-8e5e-49d3-92d4-876d3a4f0363\",\n \"email\": \"email\"\n },\n \"distribution_credentials\": {\n \"distribution_credentials_id\": \"8b36cfd0-472f-4a21-833f-2d6343c3a2f3\",\n \"provider\": \"quay\",\n \"comment\": \"My Self-Hosted Distribution Credentials\",\n \"scopes\": [\n \"self-hosted:product:api\",\n \"self-hosted:product:engine\"\n ],\n \"created\": \"2023-06-28T15:36:59.609841Z\"\n }\n },\n {\n \"member\": {\n \"member_id\": \"c7b9b131-73f3-11d9-8665-0b00d2e44b83\",\n \"email\": \"email\"\n },\n \"distribution_credentials\": {\n \"distribution_credentials_id\": \"82c32c10-53b2-4d23-993f-864b3d44502a\",\n \"provider\": \"quay\",\n \"comment\": \"My other self-hosted Distribution Credentials\",\n \"scopes\": [\n \"self-hosted:product:api\",\n \"self-hosted:product:engine\"\n ],\n \"created\": \"2023-06-28T15:36:59.609841Z\"\n }\n }\n ]\n}","language":"json","status":200},{"name":null,"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Get Credentials","icon":"","type":"endpoint","slug":"list-credentials","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-keys-copy","parentDoc":"649c91f4a708161851f9a980","category":"649fe034e9e70e0037d16c72","createdAt":"2023-06-28T20:03:47.186Z","isBodyEmpty":false,"children":[]},{"_id":"649ca3253999670185a7b4c9","api":{"method":"get","url":"/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"PROJECT_ID","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db055808a90000a69f1bf"},{"name":"distribution_credentials_id","type":"string","enumValues":"","default":"DISTRIBUTION_CREDENTIALS_ID","desc":"Unique identifier of the distribution credentials for which you want to examine. (UUID)","required":false,"in":"path","ref":"","_id":"649ca71422e37f0117b189b6"},{"name":"Authorization","type":"string","enumValues":"","default":"Token SECRET","desc":"The secret from an API key as a `Token`.","required":false,"in":"header","ref":"","_id":"649cbb9ff134e0134381373f"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl -X GET \\ 315ms  Wed Jun 28 17:12:47 2023\n -H 'Authorization: Token 4b08cefa12b80a6d16cb10c82fd8045e8f915087' \\\n https://api.deepgram.com/v1/projects/9f870faf-07a9-41b1-aa0d-de5030cb9bdc/self-hosted/distribution/credentials","language":"text","name":"curl"}]},"results":{"codes":[{"name":"","code":"{\n \"member\": {\n \"member_id\": \"c7b9b131-73f3-11d9-8665-0b00d2e44b83\",\n \"email\": \"email\"\n },\n \"distribution_credentials\": {\n \"distribution_credentials_id\": \"82c32c10-53b2-4d23-993f-864b3d44502a\",\n \"provider\": \"quay\",\n \"comment\": \"My Self-Hosted Distribution Credentials\",\n \"scopes\": [\n \"self-hosted:product:api\",\n \"self-hosted:product:engine\"\n ],\n \"created\": \"2023-06-28T15:36:59.609841Z\"\n }\n}","language":"json","status":200},{"name":null,"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Get Credential","icon":"","type":"endpoint","slug":"get-credentials","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-credentials-copy","parentDoc":"649c91f4a708161851f9a980","category":"649fe034e9e70e0037d16c72","createdAt":"2023-06-28T21:16:21.216Z","isBodyEmpty":false,"children":[]},{"_id":"649ca7dd141d56001475924f","api":{"method":"post","url":"/projects/{project_id}/self-hosted/distribution/credentials","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"PROJECT_ID","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db055808a90000a69f1bf"},{"name":"comment","type":"string","enumValues":"","default":"My self-hosted distribution credentials","desc":"A friendly name for the distribution credentials.","required":false,"in":"body","ref":"","_id":"649caae11b98b7027d893eef"},{"name":"scopes","type":"array_string","enumValues":"","default":"self-hosted:products","desc":"The product scopes granted to the credentials as an Array of Strings.","required":false,"in":"body","ref":"","_id":"649caae11b98b7027d893eee"},{"name":"Authorization","type":"string","enumValues":"","default":"Token SECRET","desc":"The secret from an API key as a `Token`.","required":false,"in":"header","ref":"","_id":"649caae11b98b7027d893eed"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"The format of the HTTP body","required":false,"in":"header","ref":"","_id":"649caae11b98b7027d893eec"},{"name":"provider","type":"string","enumValues":"","default":"quay","desc":"The provider for the distribution credentials. Only valid value is \"quay\".","required":false,"in":"body","ref":"","_id":"649caae11b98b7027d893eeb"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl -X POST \\ 300ms  Wed Jun 28 16:01:19 2023\n -H 'Authorization: Token aa4909ae0078f880a1e5846ed42e28adf8b31780' \\\n -H 'Content-Type: application/json' \\\n --url https://api.deepgram.com/v1/projects/9f870faf-07a9-41b1-aa0d-de5030cb9bdc/self-hosted/distribution/credentials -\\\n --data '{\"comment\": \"My self-hosted distribution credentials\", \"scopes\":[\"self-hosted:products\"], \"provider\": \"quay\"}'","language":"text","name":"curl"}]},"results":{"codes":[{"name":"","code":"{\n \"member\": {\n \"member_id\": \"c7b9b131-73f3-11d9-8665-0b00d2e44b83\",\n \"email\": \"email\"\n },\n \"distribution_credentials\": {\n \"distribution_credentials_id\": \"82c32c10-53b2-4d23-993f-864b3d44502a\",\n \"provider\": \"quay\",\n \"comment\": \"My Self-Hosted Distribution Credentials\",\n \"scopes\": [\n \"self-hosted:product:api\",\n \"self-hosted:product:engine\"\n ],\n \"created\": \"2023-06-28T15:36:59.609841Z\"\n }\n}","language":"json","status":200},{"name":null,"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Create Credentials","icon":"","type":"endpoint","slug":"create-credentials","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-credentials-copy","parentDoc":"649c91f4a708161851f9a980","category":"649fe034e9e70e0037d16c72","createdAt":"2023-06-28T21:36:29.662Z","isBodyEmpty":false,"children":[]},{"_id":"649cb73a457ecc00177aafb0","api":{"method":"delete","url":"/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}","auth":"required","params":[{"name":"project_id","type":"string","enumValues":"","default":"PROJECT_ID","desc":"Unique identifier of the project for which you want to get keys. (UUID)","required":false,"in":"path","ref":"","_id":"643db055808a90000a69f1bf"},{"name":"distribution_credentials_id","type":"string","enumValues":"","default":"DISTRIBUTION_CREDENTIALS_ID","desc":"Unique identifier of the distribution credentials for which you want to examine. (UUID)","required":false,"in":"path","ref":"","_id":"649ca71422e37f0117b189b6"},{"name":"Authorization","type":"string","enumValues":"","default":"Token SECRET","desc":"The secret from an API key as a `Token`.","required":false,"in":"header","ref":"","_id":"649cbc0158b306006a03ed50"}],"apiSetting":"6424a4f5e2b5be000ad8feae","examples":{"codes":[{"code":"curl -X DELETE \\\n -H 'Authorization: Token 4b08cefa12b80a6d16cb10c82fd8045e8f915087' \\\n https://api.deepgram.com/v1/projects/9f870faf-07a9-41b1-aa0d-de5030cb9bdc/self-hosted/distribution/credentials/1a9a9729-5b39-4445-86c4-c1e8a989306f","language":"text","name":"curl"}]},"results":{"codes":[{"name":"","code":"{\n \"message\": \"Successfully deleted the distribution credentials!\"\n}","language":"json","status":200},{"name":null,"code":"{\"category\":\"UNAUTHORIZED\",\"message\":\"Authentication failed.\",\"details\":\"Check that you are using the correct credentials.\",\"request_id\":\"29fcbd9f-1294-40b2-9d30-35eaad478e29\"}","language":"json","status":403},{"code":"{\n \"category\": \"NOT_FOUND\",\n \"message\": \"A project with the submitted ID cannot be found.\",\n \"details\": \"Check that you have submitted the intended project ID and that the project has not been deleted.\",\n \"request_id\": \"748f0880-8584-4003-b5aa-08168c5dd14e\"\n}","language":"json","status":404}]}},"title":"Delete Credentials","icon":"","type":"endpoint","slug":"delete-credentials","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-credentials-copy","parentDoc":"649c91f4a708161851f9a980","category":"649fe034e9e70e0037d16c72","createdAt":"2023-06-28T22:42:02.777Z","isBodyEmpty":false,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"ZjEzOTc3NzNkNmYwNTQ2MzZlMDE0MzA1ZmYxN2JiMDNlNTdhMDBmYTFhNDIwZmIwOTNkYTJmYWQ5Mzc1MzZiMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjQyMmQ3YmQyZTAzYjUwMDRjNmUwODhhKSwodmVyc2lvbjpub25lLHZlcnNpb246NjQyMmQ3YmQyZTAzYjUwMDRjNmUwODhmKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OlR1dG9yaWFsKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true},"id":"6422d7bd2e03b5004c6e088a","name":"Deepgram Docs","subdomain":"api-beta-deepgram","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"api-beta-deepgram"},"version":"1.0"}},"activeDoc":"self-hosted-self-service-tutorial","rdmd":{"baseUrl":"/","body":"Deepgram gives you the ability to self-manage your self-hosted API keys and container image distribution credentials. This offers you flexibility and control over your Deepgram self-hosted deployments using [Deepgram Console](https://console.deepgram.com) and [Quay](https://quay.io/). For example, you can rotate and expire your keys and credentials according to your access control policies.\n\nThis guide focuses on using Deepgram Console. If you would like to use the Deepgram API, see our API documentation on [creating API keys](https://developers.deepgram.com/reference/create-key#deepgram-self-hosted-api-keys) and creating [distribution credentials](https://developers.deepgram.com/reference/create-credentials). \n\n## Verifying Access to Self-Hosted Products\n\nThis guide only applies to Console projects which have been granted access to self-hosted products. If you have access, your [Console](https://console.deepgram.com/login) menu should have an \"Self-Hosted\" tab, as shown below.\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/edd10ba-ps_2024-07-15_094100.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\nIf you do not have this tab in Console, your project has either:\n\n1. Never received access to self-hosted products\n 1. To take advantage of our self-hosted product offering, you will need to enroll in a [Deepgram Enterprise Plan](https://deepgram.com/pricing). If you're interested, please [contact us](https://deepgram.com/contact-us/)!\n2. Received access to managed self-hosted products, but has not yet been granted access to self-service for these products.\n 1. Please contact your Deepgram Account Representative to enable access.\n\nWith that out of the way, we can begin!\n\n## Create a Self-Hosted API Key\n\nYou can use the [Deepgram Console](https://console.deepgram.com/login) or the Deepgram API to create a self-hosted API key for licensing Deepgram products. Follow the [Creating API Keys](doc:create-additional-api-keys) guide to create a key, and record it securely.\n\nAfter receiving your key, you can dismiss the pop-up and return to the `API Keys` page. You should see your new self-hosted API key, and if you expand the details, you can view the self-hosted products which can be licensed by that key.\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/70047e9-ps_2024-07-15_095415.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\nDepending on your self-hosted agreement with Deepgram, you may have access to different products. All self-hosted customers have access to API and Engine. For access to the [License Proxy](doc:license-proxy), please contact [Support](https://deepgram.com/contact-us/).\n\n## Create Container Image Distribution Credentials\n\nDistribution credentials are used to authenticate with a container image repository when pulling Deepgram container images into your deployment environment.\n\n> 📘 \n> \n> Distribution credentials are _not_ the same as self-hosted API keys. In our documentation, when we refer to an self-hosted API key (`DEEPGRAM_API_KEY`), this is referring to the key made in the previous section.\n\n<br />\n\n1. Back on the [Console](console.deepgram.com) page, use the menu on the left and click on the \"Self-Hosted\" tab, then click \"Create New Distribution Credentials\". \n\n ![](https://files.readme.io/edd10ba-ps_2024-07-15_094100.png)\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/d0f206c-ps_2023-08-04_095150.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\n2. Provide a name for your distribution credentials and click \"Create Credentials\". \n\n [block:image]{\"images\":[{\"image\":[\"https://files.readme.io/4c1ee36-ps_2024-07-15_095604.png\",\"\",\"\"],\"align\":\"center\"}]}[/block]\n3. Your new credentials will be shown, which include: \n\n 1. A `username`, which looks like `deepgram+6ba7b810-9dad-11d1-80b4-00c04fd430c8`.\n 2. A `secret`, which looks like `R2CTHDZ27R360V8H5LOWGBQ871HE9RP5YGWZA9JXWM3V98ST4VE3NYX72BK86Z7J`.\n 3. An example `shell` command that demonstrates how to authenticate with your credentials\n\n You can use the `secret` as your password for the `shell` command. Again, take note of the displayed values, as they can't be accessed again. Once you've copied it, check the box affirming you understand this and click \"Got it\".\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/232d72f-Screenshot_2023-06-28_at_11.47.01_AM.png\",\n null,\n \"Distribution credentials limited secret access\"\n ],\n \"align\": \"center\",\n \"sizing\": \"50% \"\n }\n ]\n}\n[/block]\n\n\n5. The pop-up will be dismissed and you will be back on the \"Self-Hosted\" page. You should see your new distribution credentials and the container images which can be accessed with those credentials. \n\n [block:image]{\"images\":[{\"image\":[\"https://files.readme.io/09ea5d9-ps_2024-07-15_095816.png\",\"\",\"\"],\"align\":\"center\"}]}[/block]\n\n## Migration for Legacy Licensing and Container Distribution\n\n> 👍 \n> \n> If you are deploying Deepgram to your environment for the first time, you may skip this section and proceed to the next guide, linked at the bottom of the page.\n\nIf your self-hosted Deepgram environment uses a static legacy license key, or you previously used DockerHub to access container images, you will need to modify your environment to use your newly generated credentials.\n\n> 📘 Checking if you need to migrate from DockerHub\n> \n> To check if you are currently pulling images from DockerHub and need to migrate to Quay, check your deployment files. Depending on your container orchestrator, this may be a Docker Compose file, a Podman Compose file, Kubernetes manifest files, or a Helm chart.\n> \n> A container image path and tag will be listed within those files. If it looks like any of the following, you are pulling from DockerHub and must migrate to Quay.\n> \n> - `deepgram/onprem-api:xxxx` \n> - `deepgram/onprem-engine:xxxx`\n> - `deepgram/onprem-license-proxy:xxxx`\n> \n> If your image tags have the prefix `quay.io`, such as some of the examples below, you are already using Quay and do not need to migrate.\n> \n> - `quay.io/deepgram/onprem-api:xxxx` \n> - `quay.io/deepgram/self-hosted-api:xxxx`\n> - `quay.io/deepgram/onprem-engine:xxxx` \n> - `quay.io/deepgram/self-hosted-engine:xxxx`\n> - `quay.io/deepgram/onprem-license-proxy:xxxx` \n> - `quay.io/deepgram/self-hosted-license-proxy:xxxx`\n\n1. Upgrade your Deepgram container images to the most recent release provided by Quay. \n 1. Login on the command line using the newly generated credentials from [Create Container Image Distribution Credentials](#create-container-images-distribution-credentials). \n 2. Follow the instructions [here](doc:deploy-deepgram-services#pull-deepgram-container-images) to pull the latest Deepgram images. \n 3. Edit your `docker-compose.yml` file (or other orchestration platform files, like Kubernetes manifest files) to use the new container image you just pulled from Quay.\n2. Replace your static legacy license key with your newly generated self-hosted API key from the [Create a Self-Hosted API Key](#create-a-self-hosted-api-key) section.\n 1. Edit any custom `api.toml` and `engine.toml` configuration files. Replace the value at `[license.key]` with your API key secret.\n 2. If needed, edit the `docker-compose.yml` file (or other orchestration platform files) to replace the key used by the License Proxy or other add-on products. Replace the value at `--license-key` with your API key secret.","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","resourceID":"64ac2302a9cd72006ec87566","resourceType":"page","baseUrl":"/","terms":[{"_id":"6442e552b7accb00668db780","term":"Ogg Opus","definition":"Opus packets encapsulated within Ogg containers, per the original\n Opus specification."},{"_id":"6442e55fc207e2001187d068","term":"Opus","definition":"Lossy audio coding algorithm designed to efficiently code speech\n and general audio in a single format, while remaining low-latency enough for\n real-time interactive communication and low-complexity enough for low-end\n embedded processors. Opus replaces both Vorbis and Speex for new applications,\n and several blind listening tests have ranked it higher quality than any other\n standard audio format at any given bitrate until transparency is reached,\n including MP3, AAC, and HE-AAC. Opus packets may be wrapped in a network\n packet that supplies the packet length. Optionally, a self-delimited packet\n format that adds one or two additional bytes per packet to encode the packet\n length may be used."},{"_id":"6442e58d5d7f9800426dfc8d","term":"Training","definition":"Process through which a machine learning algorithm is fed many\n examples of data and human input to help it identify and replicate a decision\n an expert would make when provided with that same information."},{"_id":"6442e5b0c207e2001187d8ec","term":"Word Error Rate (WER)","definition":"Common metric used to evaluate the effectiveness of automatic\n speech recognition systems (ASRs) and compare the accuracy of the transcripts\n they produce. The more technical, industry-specific, “accented”, and noisy\n your speech data is, the more likely that both ASRs (and humans) will yield a\n high WER."},{"_id":"64552c5bcb2b570034f32764","term":"Community SDK","definition":"An SDK that is not officially maintained by Deepgram, and is maintained by community members instead. The community doesn't necessarily exclude Deepgram team members."},{"_id":"6459336f62d6fe0061e0323e","term":"remote file","definition":"a file that is hosted on a remote server, not one that is on your local machine"},{"_id":"645933a8c1c86b013b4043ce","term":"local file","definition":"a file that is on your local machine, not one that is hosted on a remote server"},{"_id":"645936c0ddc14f00154465cc","term":"transcript","definition":"written text which is the result of converting speech from an audio file into text"},{"_id":"64593adb470f0c000a32f5f4","term":"transcribe","definition":"convert speech from an audio file into written text"},{"_id":"64593da09b499700125d75e7","term":"API","definition":"stands for \"application programming interface\". An API allows two separate IT entities to collaborate using a set of predefined rules for making a request and sending a response between the two entities' servers."},{"_id":"64593eef1b190c0031d1785d","term":"SDK","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the node.js and the python SDKs."},{"_id":"6459421a6dc5be000d33c52d","term":"containerized","definition":"audio stream that contains a header which specifies information about the audio."},{"_id":"645942a0556bf00063fb2c30","term":"raw","definition":"unlike containerized audio formats, raw audio does not contain a header to specify information about the audio."},{"_id":"645948ec8775f20042ddf8ac","term":"VLC","definition":"VLC is a free and open source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols. (https://www.videolan.org/vlc/)"},{"_id":"645949e97bee1100346d71fb","term":"ffmpeg","definition":"a command-line tool that can be used to record, convert, and stream audio and video."},{"_id":"64594c43de5c8f01ca70ed1d","term":"transcription","definition":"Process through which speech in an audio file is converted into written text."},{"_id":"64594eef67091b012b936fca","term":"SRT","definition":"SubRip Text (SRT) is a subtitle format which consists of a sequence of text segments associated with a time-interval. They are plain text files with no metadata, so the files are very small."},{"_id":"64594f1eb198d1003c7aa236","term":"VTT","definition":"WebVTT is a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"64596093f5b18f0725048a99","term":"WebVTT","definition":"a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"6459646f9c4fac05afbd0ddc","term":"tier","definition":"the level of model you would like to use in your request. For example, Deepgram's phonecall model has three tiers: base, enhanced, nova."},{"_id":"645a5e1070f56e2b3d395b1c","term":"streaming","definition":"audio that is delivered through an open channel in a continuous manner, where the audio data is processed bit by bit."},{"_id":"645a5e408f14742bafe7e4a1","term":"pre-recorded","definition":"refers to self-contained audio files such as WAV or MP3 files."},{"_id":"645a62412f762427053123a6","term":"project","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a6347a834032e09cd828b","term":"projects","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a90e6892dc303f3da3178","term":"Adaptive Multi-Rate","definition":"a lossy audio coding algorithm optimized for speech coding that dynamically adjusts speech bit rate and channel coding to adapt to various network conditions."},{"_id":"645a9325db7c29039d0786cd","term":"Free Lossless Audio Codec","definition":"an open, royalty-free, and efficient audio coding algorithm that can compress audio data to 50-70% of its original size while maintaining its quality, allowing for fast streaming and decoding, and enabling exact recovery of the original data at any time."},{"_id":"645a941b4fb341039ab3df7f","term":"Mu-law","definition":"a lossy audio coding algorithm that reduces the dynamic range of an audio signal by removing data from upper and lower frequencies, compresses audio data to 50% of its original size, and is commonly used as a telecommunication standard in North America and Japan."},{"_id":"645aa6b7def3610ad7f18a44","term":"dataset","definition":"collection of resources that provide a large, representative sample of data that can be transcribed, labeled, and then used to train a model."},{"_id":"645aa83aa3972c0a3a3a7092","term":"Voice Activity Detection (VAD)","definition":"a speech processing technology used to distinguish between speech and non-speech segments of an audio signal. VAD can be used in applications such as speech recognition, voice over IP (VoIP) communication, and audio coding."},{"_id":"645aa902f35aa90ad1f96e17","term":"Lossless","definition":"Class of compression algorithms that allow original data to be perfectly reconstructed from compressed data. Lossless compression is used in cases where deviations from the original data would be unfavorable."},{"_id":"645aa93b1b26f909f49dfd97","term":"Lossy","definition":"Class of compression algorithms that irreversibly degrade data quality to reduce size for storage, handling, and transmission. Well-designed lossy compression technology can significantly reduce file sizes before degradation is noticed by the end-user."},{"_id":"645aaa494bb50c07a38040f9","term":"signed PCM WAV","definition":"a digital audio format that represents analog sound waves by sampling them at regular intervals and encoding the sampled values as binary data, where the signed value indicates whether the sample is positive or negative."},{"_id":"645aab43a30de608fe5d8b6e","term":"encoding","definition":"the different algorithms used to compress digital audio data into a smaller size for efficient storage and transmission, while maintaining the perceptual quality of the original audio signal."},{"_id":"645d5b659f2f6b0623f5e225","term":"model","definition":"an algorithm that is trained to convert spoken language into written text by analyzing large datasets of spoken language and corresponding transcriptions."},{"_id":"645d5b74687a92003052ae6e","term":"resources","definition":"audio file and its associated data, such as a transcription. Resources can be collected into datasets, and a single resource can belong to\n multiple datasets."},{"_id":"64650280ac261d00f6162a01","term":"BCP-47","definition":"BCP-47 describes a syntax, called a \"language-range\", for specifying items in a user's list of language preferences: Read more https://tools.ietf.org/html/bcp47"},{"_id":"646cf5b192603a21458a20cd","term":"Real-Time Messaging Protocol","definition":"Protocol used to stream audio, video, and data over the internet. While RTMP was originally developed by Macromedia to stream between a Flash player and server, it continues to be used as an open-source protocol and is accepted by many streaming providers, such as Zoom."},{"_id":"64e65b60e50a1100654ac5cf","term":"Deprecated","definition":"In software development, \"deprecated\" refers to a feature, function, or practice that is no longer supported or recommended, but still allowed for backward compatibility or other reasons. Deprecated elements are typically marked as such in the software's documentation, and users are advised to avoid using them in new development or to migrate away from them as soon as possible."},{"_id":"65bd5c3b557eb9005625f02d","term":"SDKs","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the Javascript and the Python SDKs."},{"_id":"65c13b0c328f8000421c9980","term":"DSLM","definition":"A Domain-Specific Language Model (DSLM) is a specialized machine learning model designed for a particular domain or task. In contrast to Large Language Models (LLMs), DSLMs are characterized by a narrower scope, with a focus on high accuracy and low latency within a specific context, typically having fewer parameters tailored to the targeted domain."},{"_id":"65c145d74498110031aa2078","term":"TSLM","definition":"A Task-Specific Language Model (TSLM) is a specialized machine learning model fine-tuned for specific tasks. Unlike more broadly applicable Large Language Models (LLMs), TSLMs excel with high accuracy and low latency in their designated areas, boasting a compact architecture optimized for task-specific performance."},{"_id":"66182534818d8400186969da","term":"speex","definition":"Speex is an open-source audio compression format designed for speech applications. Offering variable bit rate modes and support for narrowband and wideband audio, it excels in efficiency and versatility. Its low-latency capabilities make it ideal for real-time communication, while features like noise suppression enhance speech clarity. In summary, Speex provides an effective balance between compression efficiency and audio quality for speech-centric tasks."},{"_id":"661826a16f266c001198833d","term":"G729","definition":"G.729 is a codec designed for low-bandwidth communication, offering efficient speech compression for applications like VoIP. It achieves high compression ratios while maintaining acceptable speech quality, making it ideal for conserving network bandwidth in digital telephony systems."}],"variables":{"user":{},"defaults":[]}},"terms":[{"_id":"6442e552b7accb00668db780","term":"Ogg Opus","definition":"Opus packets encapsulated within Ogg containers, per the original\n Opus specification."},{"_id":"6442e55fc207e2001187d068","term":"Opus","definition":"Lossy audio coding algorithm designed to efficiently code speech\n and general audio in a single format, while remaining low-latency enough for\n real-time interactive communication and low-complexity enough for low-end\n embedded processors. Opus replaces both Vorbis and Speex for new applications,\n and several blind listening tests have ranked it higher quality than any other\n standard audio format at any given bitrate until transparency is reached,\n including MP3, AAC, and HE-AAC. Opus packets may be wrapped in a network\n packet that supplies the packet length. Optionally, a self-delimited packet\n format that adds one or two additional bytes per packet to encode the packet\n length may be used."},{"_id":"6442e58d5d7f9800426dfc8d","term":"Training","definition":"Process through which a machine learning algorithm is fed many\n examples of data and human input to help it identify and replicate a decision\n an expert would make when provided with that same information."},{"_id":"6442e5b0c207e2001187d8ec","term":"Word Error Rate (WER)","definition":"Common metric used to evaluate the effectiveness of automatic\n speech recognition systems (ASRs) and compare the accuracy of the transcripts\n they produce. The more technical, industry-specific, “accented”, and noisy\n your speech data is, the more likely that both ASRs (and humans) will yield a\n high WER."},{"_id":"64552c5bcb2b570034f32764","term":"Community SDK","definition":"An SDK that is not officially maintained by Deepgram, and is maintained by community members instead. The community doesn't necessarily exclude Deepgram team members."},{"_id":"6459336f62d6fe0061e0323e","term":"remote file","definition":"a file that is hosted on a remote server, not one that is on your local machine"},{"_id":"645933a8c1c86b013b4043ce","term":"local file","definition":"a file that is on your local machine, not one that is hosted on a remote server"},{"_id":"645936c0ddc14f00154465cc","term":"transcript","definition":"written text which is the result of converting speech from an audio file into text"},{"_id":"64593adb470f0c000a32f5f4","term":"transcribe","definition":"convert speech from an audio file into written text"},{"_id":"64593da09b499700125d75e7","term":"API","definition":"stands for \"application programming interface\". An API allows two separate IT entities to collaborate using a set of predefined rules for making a request and sending a response between the two entities' servers."},{"_id":"64593eef1b190c0031d1785d","term":"SDK","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the node.js and the python SDKs."},{"_id":"6459421a6dc5be000d33c52d","term":"containerized","definition":"audio stream that contains a header which specifies information about the audio."},{"_id":"645942a0556bf00063fb2c30","term":"raw","definition":"unlike containerized audio formats, raw audio does not contain a header to specify information about the audio."},{"_id":"645948ec8775f20042ddf8ac","term":"VLC","definition":"VLC is a free and open source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols. (https://www.videolan.org/vlc/)"},{"_id":"645949e97bee1100346d71fb","term":"ffmpeg","definition":"a command-line tool that can be used to record, convert, and stream audio and video."},{"_id":"64594c43de5c8f01ca70ed1d","term":"transcription","definition":"Process through which speech in an audio file is converted into written text."},{"_id":"64594eef67091b012b936fca","term":"SRT","definition":"SubRip Text (SRT) is a subtitle format which consists of a sequence of text segments associated with a time-interval. They are plain text files with no metadata, so the files are very small."},{"_id":"64594f1eb198d1003c7aa236","term":"VTT","definition":"WebVTT is a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"64596093f5b18f0725048a99","term":"WebVTT","definition":"a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"6459646f9c4fac05afbd0ddc","term":"tier","definition":"the level of model you would like to use in your request. For example, Deepgram's phonecall model has three tiers: base, enhanced, nova."},{"_id":"645a5e1070f56e2b3d395b1c","term":"streaming","definition":"audio that is delivered through an open channel in a continuous manner, where the audio data is processed bit by bit."},{"_id":"645a5e408f14742bafe7e4a1","term":"pre-recorded","definition":"refers to self-contained audio files such as WAV or MP3 files."},{"_id":"645a62412f762427053123a6","term":"project","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a6347a834032e09cd828b","term":"projects","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a90e6892dc303f3da3178","term":"Adaptive Multi-Rate","definition":"a lossy audio coding algorithm optimized for speech coding that dynamically adjusts speech bit rate and channel coding to adapt to various network conditions."},{"_id":"645a9325db7c29039d0786cd","term":"Free Lossless Audio Codec","definition":"an open, royalty-free, and efficient audio coding algorithm that can compress audio data to 50-70% of its original size while maintaining its quality, allowing for fast streaming and decoding, and enabling exact recovery of the original data at any time."},{"_id":"645a941b4fb341039ab3df7f","term":"Mu-law","definition":"a lossy audio coding algorithm that reduces the dynamic range of an audio signal by removing data from upper and lower frequencies, compresses audio data to 50% of its original size, and is commonly used as a telecommunication standard in North America and Japan."},{"_id":"645aa6b7def3610ad7f18a44","term":"dataset","definition":"collection of resources that provide a large, representative sample of data that can be transcribed, labeled, and then used to train a model."},{"_id":"645aa83aa3972c0a3a3a7092","term":"Voice Activity Detection (VAD)","definition":"a speech processing technology used to distinguish between speech and non-speech segments of an audio signal. VAD can be used in applications such as speech recognition, voice over IP (VoIP) communication, and audio coding."},{"_id":"645aa902f35aa90ad1f96e17","term":"Lossless","definition":"Class of compression algorithms that allow original data to be perfectly reconstructed from compressed data. Lossless compression is used in cases where deviations from the original data would be unfavorable."},{"_id":"645aa93b1b26f909f49dfd97","term":"Lossy","definition":"Class of compression algorithms that irreversibly degrade data quality to reduce size for storage, handling, and transmission. Well-designed lossy compression technology can significantly reduce file sizes before degradation is noticed by the end-user."},{"_id":"645aaa494bb50c07a38040f9","term":"signed PCM WAV","definition":"a digital audio format that represents analog sound waves by sampling them at regular intervals and encoding the sampled values as binary data, where the signed value indicates whether the sample is positive or negative."},{"_id":"645aab43a30de608fe5d8b6e","term":"encoding","definition":"the different algorithms used to compress digital audio data into a smaller size for efficient storage and transmission, while maintaining the perceptual quality of the original audio signal."},{"_id":"645d5b659f2f6b0623f5e225","term":"model","definition":"an algorithm that is trained to convert spoken language into written text by analyzing large datasets of spoken language and corresponding transcriptions."},{"_id":"645d5b74687a92003052ae6e","term":"resources","definition":"audio file and its associated data, such as a transcription. Resources can be collected into datasets, and a single resource can belong to\n multiple datasets."},{"_id":"64650280ac261d00f6162a01","term":"BCP-47","definition":"BCP-47 describes a syntax, called a \"language-range\", for specifying items in a user's list of language preferences: Read more https://tools.ietf.org/html/bcp47"},{"_id":"646cf5b192603a21458a20cd","term":"Real-Time Messaging Protocol","definition":"Protocol used to stream audio, video, and data over the internet. While RTMP was originally developed by Macromedia to stream between a Flash player and server, it continues to be used as an open-source protocol and is accepted by many streaming providers, such as Zoom."},{"_id":"64e65b60e50a1100654ac5cf","term":"Deprecated","definition":"In software development, \"deprecated\" refers to a feature, function, or practice that is no longer supported or recommended, but still allowed for backward compatibility or other reasons. Deprecated elements are typically marked as such in the software's documentation, and users are advised to avoid using them in new development or to migrate away from them as soon as possible."},{"_id":"65bd5c3b557eb9005625f02d","term":"SDKs","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the Javascript and the Python SDKs."},{"_id":"65c13b0c328f8000421c9980","term":"DSLM","definition":"A Domain-Specific Language Model (DSLM) is a specialized machine learning model designed for a particular domain or task. In contrast to Large Language Models (LLMs), DSLMs are characterized by a narrower scope, with a focus on high accuracy and low latency within a specific context, typically having fewer parameters tailored to the targeted domain."},{"_id":"65c145d74498110031aa2078","term":"TSLM","definition":"A Task-Specific Language Model (TSLM) is a specialized machine learning model fine-tuned for specific tasks. Unlike more broadly applicable Large Language Models (LLMs), TSLMs excel with high accuracy and low latency in their designated areas, boasting a compact architecture optimized for task-specific performance."},{"_id":"66182534818d8400186969da","term":"speex","definition":"Speex is an open-source audio compression format designed for speech applications. Offering variable bit rate modes and support for narrowband and wideband audio, it excels in efficiency and versatility. Its low-latency capabilities make it ideal for real-time communication, while features like noise suppression enhance speech clarity. In summary, Speex provides an effective balance between compression efficiency and audio quality for speech-centric tasks."},{"_id":"661826a16f266c001198833d","term":"G729","definition":"G.729 is a codec designed for low-bandwidth communication, offering efficient speech compression for applications like VoIP. It achieves high compression ratios while maintaining acceptable speech quality, making it ideal for conserving network bandwidth in digital telephony systems."}],"variables":{"user":{},"defaults":[]},"mdx":false,"dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li><a href=\"#verifying-access-to-self-hosted-products\">Verifying Access to Self-Hosted Products</a></li>\n<li><a href=\"#create-a-self-hosted-api-key\">Create a Self-Hosted API Key</a></li>\n<li><a href=\"#create-container-image-distribution-credentials\">Create Container Image Distribution Credentials</a></li>\n<li><a href=\"#migration-for-legacy-licensing-and-container-distribution\">Migration for Legacy Licensing and Container Distribution</a></li>\n</ul></li></ul></nav>","body":"<p>Deepgram gives you the ability to self-manage your self-hosted API keys and container image distribution credentials. This offers you flexibility and control over your Deepgram self-hosted deployments using <a href=\"https://console.deepgram.com\" target=\"\" title=\"\">Deepgram Console</a> and <a href=\"https://quay.io/\" target=\"\" title=\"\">Quay</a>. For example, you can rotate and expire your keys and credentials according to your access control policies.</p>\n<p>This guide focuses on using Deepgram Console. If you would like to use the Deepgram API, see our API documentation on <a href=\"https://developers.deepgram.com/reference/create-key#deepgram-self-hosted-api-keys\" target=\"\" title=\"\">creating API keys</a> and creating <a href=\"https://developers.deepgram.com/reference/create-credentials\" target=\"\" title=\"\">distribution credentials</a>. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"verifying-access-to-self-hosted-products\"></div><div class=\"heading-text\"><div id=\"section-verifying-access-to-self-hosted-products\" class=\"heading-anchor_backwardsCompatibility\"></div>Verifying Access to Self-Hosted Products</div><a aria-label=\"Skip link to Verifying Access to Self-Hosted Products\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#verifying-access-to-self-hosted-products\"></a></h2>\n<p>This guide only applies to Console projects which have been granted access to self-hosted products. If you have access, your <a href=\"https://console.deepgram.com/login\" target=\"\" title=\"\">Console</a> menu should have an &quot;Self-Hosted&quot; tab, as shown below.</p>\n<span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/edd10ba-ps_2024-07-15_094100.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"/></span></span>\n<p>If you do not have this tab in Console, your project has either:</p>\n<ol>\n<li>Never received access to self-hosted products\n<ol>\n<li>To take advantage of our self-hosted product offering, you will need to enroll in a <a href=\"https://deepgram.com/pricing\" target=\"\" title=\"\">Deepgram Enterprise Plan</a>. If you&#x27;re interested, please <a href=\"https://deepgram.com/contact-us/\" target=\"\" title=\"\">contact us</a>!</li>\n</ol>\n</li>\n<li>Received access to managed self-hosted products, but has not yet been granted access to self-service for these products.\n<ol>\n<li>Please contact your Deepgram Account Representative to enable access.</li>\n</ol>\n</li>\n</ol>\n<p>With that out of the way, we can begin!</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"create-a-self-hosted-api-key\"></div><div class=\"heading-text\"><div id=\"section-create-a-self-hosted-api-key\" class=\"heading-anchor_backwardsCompatibility\"></div>Create a Self-Hosted API Key</div><a aria-label=\"Skip link to Create a Self-Hosted API Key\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#create-a-self-hosted-api-key\"></a></h2>\n<p>You can use the <a href=\"https://console.deepgram.com/login\" target=\"\" title=\"\">Deepgram Console</a> or the Deepgram API to create a self-hosted API key for licensing Deepgram products. Follow the <a href=\"/docs/create-additional-api-keys\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"create-additional-api-keys\">Creating API Keys</a> guide to create a key, and record it securely.</p>\n<p>After receiving your key, you can dismiss the pop-up and return to the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">API Keys</code> page. You should see your new self-hosted API key, and if you expand the details, you can view the self-hosted products which can be licensed by that key.</p>\n<span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/70047e9-ps_2024-07-15_095415.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"/></span></span>\n<p>Depending on your self-hosted agreement with Deepgram, you may have access to different products. All self-hosted customers have access to API and Engine. For access to the <a href=\"/docs/license-proxy\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"license-proxy\">License Proxy</a>, please contact <a href=\"https://deepgram.com/contact-us/\" target=\"\" title=\"\">Support</a>.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"create-container-image-distribution-credentials\"></div><div class=\"heading-text\"><div id=\"section-create-container-image-distribution-credentials\" class=\"heading-anchor_backwardsCompatibility\"></div>Create Container Image Distribution Credentials</div><a aria-label=\"Skip link to Create Container Image Distribution Credentials\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#create-container-image-distribution-credentials\"></a></h2>\n<p>Distribution credentials are used to authenticate with a container image repository when pulling Deepgram container images into your deployment environment.</p>\n<blockquote class=\"callout callout_info\" theme=\"📘\"><h2 class=\"callout-heading empty\"><span class=\"callout-icon\">📘</span></h2><p>Distribution credentials are <em>not</em> the same as self-hosted API keys. In our documentation, when we refer to an self-hosted API key (<button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">DEEPGRAM_API_KEY</code>), this is referring to the key made in the previous section.</p></blockquote>\n<br/>\n<ol>\n<li>\n<p>Back on the <a href=\"console.deepgram.com\" target=\"\" title=\"\">Console</a> page, use the menu on the left and click on the &quot;Self-Hosted&quot; tab, then click &quot;Create New Distribution Credentials&quot;. </p>\n<p><span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/edd10ba-ps_2024-07-15_094100.png\" align=\"\" caption=\"\" height=\"auto\" title=\"\" width=\"auto\"/></span></span></p>\n</li>\n</ol>\n<span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/d0f206c-ps_2023-08-04_095150.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"/></span></span>\n<ol start=\"2\">\n<li>\n<p>Provide a name for your distribution credentials and click &quot;Create Credentials&quot;. </p>\n<span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/4c1ee36-ps_2024-07-15_095604.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"/></span></span>\n</li>\n<li>\n<p>Your new credentials will be shown, which include: </p>\n<ol>\n<li>A <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">username</code>, which looks like <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">deepgram+6ba7b810-9dad-11d1-80b4-00c04fd430c8</code>.</li>\n<li>A <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">secret</code>, which looks like <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">R2CTHDZ27R360V8H5LOWGBQ871HE9RP5YGWZA9JXWM3V98ST4VE3NYX72BK86Z7J</code>.</li>\n<li>An example <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">shell</code> command that demonstrates how to authenticate with your credentials</li>\n</ol>\n<p>You can use the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">secret</code> as your password for the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">shell</code> command. Again, take note of the displayed values, as they can&#x27;t be accessed again. Once you&#x27;ve copied it, check the box affirming you understand this and click &quot;Got it&quot;.</p>\n</li>\n</ol>\n<span aria-label=\"Distribution credentials limited secret access\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"Distribution credentials limited secret access\" loading=\"lazy\" src=\"https://files.readme.io/232d72f-Screenshot_2023-06-28_at_11.47.01_AM.png\" align=\"center\" class=\"\" width=\"50% \" caption=\"\" height=\"auto\" title=\"\"/></span></span>\n<ol start=\"5\">\n<li>\n<p>The pop-up will be dismissed and you will be back on the &quot;Self-Hosted&quot; page. You should see your new distribution credentials and the container images which can be accessed with those credentials. </p>\n<span aria-label=\"\" class=\"img lightbox closed\" role=\"button\" tabindex=\"0\"><span class=\"lightbox-inner\"><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/09ea5d9-ps_2024-07-15_095816.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"/></span></span>\n</li>\n</ol>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"migration-for-legacy-licensing-and-container-distribution\"></div><div class=\"heading-text\"><div id=\"section-migration-for-legacy-licensing-and-container-distribution\" class=\"heading-anchor_backwardsCompatibility\"></div>Migration for Legacy Licensing and Container Distribution</div><a aria-label=\"Skip link to Migration for Legacy Licensing and Container Distribution\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#migration-for-legacy-licensing-and-container-distribution\"></a></h2>\n<blockquote class=\"callout callout_okay\" theme=\"👍\"><h2 class=\"callout-heading empty\"><span class=\"callout-icon\">👍</span></h2><p>If you are deploying Deepgram to your environment for the first time, you may skip this section and proceed to the next guide, linked at the bottom of the page.</p></blockquote>\n<p>If your self-hosted Deepgram environment uses a static legacy license key, or you previously used DockerHub to access container images, you will need to modify your environment to use your newly generated credentials.</p>\n<blockquote class=\"callout callout_info\" theme=\"📘\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">📘</span><p>Checking if you need to migrate from DockerHub</p></h2><p>To check if you are currently pulling images from DockerHub and need to migrate to Quay, check your deployment files. Depending on your container orchestrator, this may be a Docker Compose file, a Podman Compose file, Kubernetes manifest files, or a Helm chart.</p><p>A container image path and tag will be listed within those files. If it looks like any of the following, you are pulling from DockerHub and must migrate to Quay.</p><ul>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">deepgram/onprem-api:xxxx</code> </li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">deepgram/onprem-engine:xxxx</code></li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">deepgram/onprem-license-proxy:xxxx</code></li>\n</ul><p>If your image tags have the prefix <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io</code>, such as some of the examples below, you are already using Quay and do not need to migrate.</p><ul>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/onprem-api:xxxx</code> </li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/self-hosted-api:xxxx</code></li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/onprem-engine:xxxx</code> </li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/self-hosted-engine:xxxx</code></li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/onprem-license-proxy:xxxx</code> </li>\n<li><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">quay.io/deepgram/self-hosted-license-proxy:xxxx</code></li>\n</ul></blockquote>\n<ol>\n<li>Upgrade your Deepgram container images to the most recent release provided by Quay. \n<ol>\n<li>Login on the command line using the newly generated credentials from <a href=\"#create-container-images-distribution-credentials\" target=\"\" title=\"\">Create Container Image Distribution Credentials</a>. </li>\n<li>Follow the instructions <a href=\"/docs/deploy-deepgram-services#pull-deepgram-container-images\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"deploy-deepgram-services#pull-deepgram-container-images\">here</a> to pull the latest Deepgram images. </li>\n<li>Edit your <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">docker-compose.yml</code> file (or other orchestration platform files, like Kubernetes manifest files) to use the new container image you just pulled from Quay.</li>\n</ol>\n</li>\n<li>Replace your static legacy license key with your newly generated self-hosted API key from the <a href=\"#create-a-self-hosted-api-key\" target=\"\" title=\"\">Create a Self-Hosted API Key</a> section.\n<ol>\n<li>Edit any custom <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">api.toml</code> and <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">engine.toml</code> configuration files. Replace the value at <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">[license.key]</code> with your API key secret.</li>\n<li>If needed, edit the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">docker-compose.yml</code> file (or other orchestration platform files) to replace the key used by the License Proxy or other add-on products. Replace the value at <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">--license-key</code> with your API key secret.</li>\n</ol>\n</li>\n</ol>"}},"doc":{"metadata":{"image":[],"title":"Self-Hosted Deployment with Deepgram Using Self Service","description":"Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API.","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"next":{"description":"Whether you are spinning up a new deployment environment, or modifying an existing environment to use your new self-service credentials, the next step is to deploy Deepgram services with your container orchestration tool of choice.","pages":[{"type":"url","value":"https://developers.deepgram.com/docs/deploy-deepgram-services","name":"Deploy Deepgram with Docker/Podman"},{"type":"url","value":"https://developers.deepgram.com/docs/kubernetes","name":"Deploy Deepgram with Kubernetes"}]},"algolia":{"recordCount":5,"publishPending":false,"translationFailure":false,"updatedAt":"2024-12-13T20:44:08.674Z"},"title":"Self Service Licensing & Credentials","icon":"","updates":[],"type":"basic","slug":"self-hosted-self-service-tutorial","excerpt":"Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API.","body":"Deepgram gives you the ability to self-manage your self-hosted API keys and container image distribution credentials. This offers you flexibility and control over your Deepgram self-hosted deployments using [Deepgram Console](https://console.deepgram.com) and [Quay](https://quay.io/). For example, you can rotate and expire your keys and credentials according to your access control policies.\n\nThis guide focuses on using Deepgram Console. If you would like to use the Deepgram API, see our API documentation on [creating API keys](https://developers.deepgram.com/reference/create-key#deepgram-self-hosted-api-keys) and creating [distribution credentials](https://developers.deepgram.com/reference/create-credentials). \n\n## Verifying Access to Self-Hosted Products\n\nThis guide only applies to Console projects which have been granted access to self-hosted products. If you have access, your [Console](https://console.deepgram.com/login) menu should have an \"Self-Hosted\" tab, as shown below.\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/edd10ba-ps_2024-07-15_094100.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\nIf you do not have this tab in Console, your project has either:\n\n1. Never received access to self-hosted products\n 1. To take advantage of our self-hosted product offering, you will need to enroll in a [Deepgram Enterprise Plan](https://deepgram.com/pricing). If you're interested, please [contact us](https://deepgram.com/contact-us/)!\n2. Received access to managed self-hosted products, but has not yet been granted access to self-service for these products.\n 1. Please contact your Deepgram Account Representative to enable access.\n\nWith that out of the way, we can begin!\n\n## Create a Self-Hosted API Key\n\nYou can use the [Deepgram Console](https://console.deepgram.com/login) or the Deepgram API to create a self-hosted API key for licensing Deepgram products. Follow the [Creating API Keys](doc:create-additional-api-keys) guide to create a key, and record it securely.\n\nAfter receiving your key, you can dismiss the pop-up and return to the `API Keys` page. You should see your new self-hosted API key, and if you expand the details, you can view the self-hosted products which can be licensed by that key.\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/70047e9-ps_2024-07-15_095415.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\nDepending on your self-hosted agreement with Deepgram, you may have access to different products. All self-hosted customers have access to API and Engine. For access to the [License Proxy](doc:license-proxy), please contact [Support](https://deepgram.com/contact-us/).\n\n## Create Container Image Distribution Credentials\n\nDistribution credentials are used to authenticate with a container image repository when pulling Deepgram container images into your deployment environment.\n\n> 📘 \n> \n> Distribution credentials are _not_ the same as self-hosted API keys. In our documentation, when we refer to an self-hosted API key (`DEEPGRAM_API_KEY`), this is referring to the key made in the previous section.\n\n<br />\n\n1. Back on the [Console](console.deepgram.com) page, use the menu on the left and click on the \"Self-Hosted\" tab, then click \"Create New Distribution Credentials\". \n\n ![](https://files.readme.io/edd10ba-ps_2024-07-15_094100.png)\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/d0f206c-ps_2023-08-04_095150.png\",\n \"\",\n \"\"\n ],\n \"align\": \"center\"\n }\n ]\n}\n[/block]\n\n\n2. Provide a name for your distribution credentials and click \"Create Credentials\". \n\n [block:image]{\"images\":[{\"image\":[\"https://files.readme.io/4c1ee36-ps_2024-07-15_095604.png\",\"\",\"\"],\"align\":\"center\"}]}[/block]\n3. Your new credentials will be shown, which include: \n\n 1. A `username`, which looks like `deepgram+6ba7b810-9dad-11d1-80b4-00c04fd430c8`.\n 2. A `secret`, which looks like `R2CTHDZ27R360V8H5LOWGBQ871HE9RP5YGWZA9JXWM3V98ST4VE3NYX72BK86Z7J`.\n 3. An example `shell` command that demonstrates how to authenticate with your credentials\n\n You can use the `secret` as your password for the `shell` command. Again, take note of the displayed values, as they can't be accessed again. Once you've copied it, check the box affirming you understand this and click \"Got it\".\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/232d72f-Screenshot_2023-06-28_at_11.47.01_AM.png\",\n null,\n \"Distribution credentials limited secret access\"\n ],\n \"align\": \"center\",\n \"sizing\": \"50% \"\n }\n ]\n}\n[/block]\n\n\n5. The pop-up will be dismissed and you will be back on the \"Self-Hosted\" page. You should see your new distribution credentials and the container images which can be accessed with those credentials. \n\n [block:image]{\"images\":[{\"image\":[\"https://files.readme.io/09ea5d9-ps_2024-07-15_095816.png\",\"\",\"\"],\"align\":\"center\"}]}[/block]\n\n## Migration for Legacy Licensing and Container Distribution\n\n> 👍 \n> \n> If you are deploying Deepgram to your environment for the first time, you may skip this section and proceed to the next guide, linked at the bottom of the page.\n\nIf your self-hosted Deepgram environment uses a static legacy license key, or you previously used DockerHub to access container images, you will need to modify your environment to use your newly generated credentials.\n\n> 📘 Checking if you need to migrate from DockerHub\n> \n> To check if you are currently pulling images from DockerHub and need to migrate to Quay, check your deployment files. Depending on your container orchestrator, this may be a Docker Compose file, a Podman Compose file, Kubernetes manifest files, or a Helm chart.\n> \n> A container image path and tag will be listed within those files. If it looks like any of the following, you are pulling from DockerHub and must migrate to Quay.\n> \n> - `deepgram/onprem-api:xxxx` \n> - `deepgram/onprem-engine:xxxx`\n> - `deepgram/onprem-license-proxy:xxxx`\n> \n> If your image tags have the prefix `quay.io`, such as some of the examples below, you are already using Quay and do not need to migrate.\n> \n> - `quay.io/deepgram/onprem-api:xxxx` \n> - `quay.io/deepgram/self-hosted-api:xxxx`\n> - `quay.io/deepgram/onprem-engine:xxxx` \n> - `quay.io/deepgram/self-hosted-engine:xxxx`\n> - `quay.io/deepgram/onprem-license-proxy:xxxx` \n> - `quay.io/deepgram/self-hosted-license-proxy:xxxx`\n\n1. Upgrade your Deepgram container images to the most recent release provided by Quay. \n 1. Login on the command line using the newly generated credentials from [Create Container Image Distribution Credentials](#create-container-images-distribution-credentials). \n 2. Follow the instructions [here](doc:deploy-deepgram-services#pull-deepgram-container-images) to pull the latest Deepgram images. \n 3. Edit your `docker-compose.yml` file (or other orchestration platform files, like Kubernetes manifest files) to use the new container image you just pulled from Quay.\n2. Replace your static legacy license key with your newly generated self-hosted API key from the [Create a Self-Hosted API Key](#create-a-self-hosted-api-key) section.\n 1. Edit any custom `api.toml` and `engine.toml` configuration files. Replace the value at `[license.key]` with your API key secret.\n 2. If needed, edit the `docker-compose.yml` file (or other orchestration platform files) to replace the key used by the License Proxy or other add-on products. Replace the value at `--license-key` with your API key secret.","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"on-prem-self-service-tutorial","slugUpdatedAt":"2024-05-22T11:14:51.465Z","revision":110,"_id":"64ac2302a9cd72006ec87566","user":"64837be18ed1970023ada69b","project":"6422d7bd2e03b5004c6e088a","parentDoc":null,"category":{"title":"Self-Hosted Deployments","slug":"on-premises-deployments","order":7,"reference":false,"_id":"64412e928a7a28055a7d600e","project":"6422d7bd2e03b5004c6e088a","version":"6422d7bd2e03b5004c6e088f","createdAt":"2023-04-20T12:22:42.434Z","__v":0,"type":"guide","id":"64412e928a7a28055a7d600e"},"createdAt":"2023-07-10T15:25:54.906Z","updatedAt":"2024-12-13T20:44:08.680Z","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0893","6422d7bd2e03b5004c6e089a","64249ca11af6b70060c01043","6424a02a77725700422bd931","6424a3d7348139003e70cceb","6424a3ee348139003e70d0bb","6424a413d75b82003d8f92d0","6424a4f5e2b5be000ad8feb0","6424a5412ec422000a10540b","643961bcd95983001d22375f","643d83a7dfef9d0d500b9d18","643d83b0019f6f0035cab192","643d83b7379fb80d4fcff8f2","643ec43d81d9d40e6e420316","643ec443808a90000a80dd5a","6441165629841e05b46091bb","64412e928a7a28055a7d600e","64493f77eec9471292699395","644f9f168466070049f89ec6","645be9db918e7d0027fc861a","645be9f0a38e0d0142cc95a6","645be9fd918e7d0027fc8a47","645bea05f9b18c0021f4ecf0","645bea0d7a5a290027238f9c","645beca754616e001e365321","645bef89b9c9460026f270e8","6466697af06669003714b160","649fe034e9e70e0037d16c72","64dd0df373eaac0042fc61d9","64dd0e50de07f5004396ced7","64e8dbef77fdce000b621f87","655bd6a1a7dded00572afeb4","6564ca81cf6c370018ccd346","656e38a26a272200770e4a42","65724eaafa82ae0070a29355","65835c6c837d30002a8f700a","6583670921487c000fb1ab21","6583675b77c3a1004eca9150","65836781c0cfb00038820405","6583679878340f005b381b7a","65837404952f290010596a00","6584a321d45d5c005ddc6330","658d655ee44e4a00238ce372","65bd1459a8f9cd0063a614a1","65d7ae457616c60024cbb51c","65d8f59e948bdb002f4e1fff","65de216884e02c006039c4e1","66050ca0294a25002b032088","6670aace1dfc1c007642c46f","66b302b66c773d0025da67df","66ccdad55d5add0062424f08","66ccde4f4db0a00019aea808","671694a7bd44f5004ced168a","67180693b1bffb0054dfa424"],"pdfStatus":"","_id":"6422d7bd2e03b5004c6e088f","project":"6422d7bd2e03b5004c6e088a","releaseDate":"2023-03-28T12:04:13.477Z","createdAt":"2023-03-28T12:04:13.477Z","__v":1,"updatedAt":"2024-10-22T20:09:55.913Z"},"__v":6,"lastUpdatedHash":"c02c797fa98a0c932ad62ac4891ec0327dd5baf1","isApi":false,"tutorials":[],"id":"64ac2302a9cd72006ec87566"},"hideTOC":false,"meta":{"_id":"64ac2302a9cd72006ec87566","description":"Learn how to deploy Deepgram self-hosted using self service. Deepgram’s self-serve self-hosted solution is available through both the Deepgram Console and the Deepgram API.","hidden":false,"image":[],"keywords":"","metaTitle":"Self-Hosted Deployment with Deepgram Using Self Service","parent":null,"robots":"index","slug":"self-hosted-self-service-tutorial","title":"Self Service Licensing & Credentials","type":"docs"},"slugUrl":"/docs/self-hosted-self-service-tutorial","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.250.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"6442e552b7accb00668db780","term":"Ogg Opus","definition":"Opus packets encapsulated within Ogg containers, per the original\n Opus specification."},{"_id":"6442e55fc207e2001187d068","term":"Opus","definition":"Lossy audio coding algorithm designed to efficiently code speech\n and general audio in a single format, while remaining low-latency enough for\n real-time interactive communication and low-complexity enough for low-end\n embedded processors. Opus replaces both Vorbis and Speex for new applications,\n and several blind listening tests have ranked it higher quality than any other\n standard audio format at any given bitrate until transparency is reached,\n including MP3, AAC, and HE-AAC. Opus packets may be wrapped in a network\n packet that supplies the packet length. Optionally, a self-delimited packet\n format that adds one or two additional bytes per packet to encode the packet\n length may be used."},{"_id":"6442e58d5d7f9800426dfc8d","term":"Training","definition":"Process through which a machine learning algorithm is fed many\n examples of data and human input to help it identify and replicate a decision\n an expert would make when provided with that same information."},{"_id":"6442e5b0c207e2001187d8ec","term":"Word Error Rate (WER)","definition":"Common metric used to evaluate the effectiveness of automatic\n speech recognition systems (ASRs) and compare the accuracy of the transcripts\n they produce. The more technical, industry-specific, “accented”, and noisy\n your speech data is, the more likely that both ASRs (and humans) will yield a\n high WER."},{"_id":"64552c5bcb2b570034f32764","term":"Community SDK","definition":"An SDK that is not officially maintained by Deepgram, and is maintained by community members instead. The community doesn't necessarily exclude Deepgram team members."},{"_id":"6459336f62d6fe0061e0323e","term":"remote file","definition":"a file that is hosted on a remote server, not one that is on your local machine"},{"_id":"645933a8c1c86b013b4043ce","term":"local file","definition":"a file that is on your local machine, not one that is hosted on a remote server"},{"_id":"645936c0ddc14f00154465cc","term":"transcript","definition":"written text which is the result of converting speech from an audio file into text"},{"_id":"64593adb470f0c000a32f5f4","term":"transcribe","definition":"convert speech from an audio file into written text"},{"_id":"64593da09b499700125d75e7","term":"API","definition":"stands for \"application programming interface\". An API allows two separate IT entities to collaborate using a set of predefined rules for making a request and sending a response between the two entities' servers."},{"_id":"64593eef1b190c0031d1785d","term":"SDK","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the node.js and the python SDKs."},{"_id":"6459421a6dc5be000d33c52d","term":"containerized","definition":"audio stream that contains a header which specifies information about the audio."},{"_id":"645942a0556bf00063fb2c30","term":"raw","definition":"unlike containerized audio formats, raw audio does not contain a header to specify information about the audio."},{"_id":"645948ec8775f20042ddf8ac","term":"VLC","definition":"VLC is a free and open source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols. (https://www.videolan.org/vlc/)"},{"_id":"645949e97bee1100346d71fb","term":"ffmpeg","definition":"a command-line tool that can be used to record, convert, and stream audio and video."},{"_id":"64594c43de5c8f01ca70ed1d","term":"transcription","definition":"Process through which speech in an audio file is converted into written text."},{"_id":"64594eef67091b012b936fca","term":"SRT","definition":"SubRip Text (SRT) is a subtitle format which consists of a sequence of text segments associated with a time-interval. They are plain text files with no metadata, so the files are very small."},{"_id":"64594f1eb198d1003c7aa236","term":"VTT","definition":"WebVTT is a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"64596093f5b18f0725048a99","term":"WebVTT","definition":"a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"6459646f9c4fac05afbd0ddc","term":"tier","definition":"the level of model you would like to use in your request. For example, Deepgram's phonecall model has three tiers: base, enhanced, nova."},{"_id":"645a5e1070f56e2b3d395b1c","term":"streaming","definition":"audio that is delivered through an open channel in a continuous manner, where the audio data is processed bit by bit."},{"_id":"645a5e408f14742bafe7e4a1","term":"pre-recorded","definition":"refers to self-contained audio files such as WAV or MP3 files."},{"_id":"645a62412f762427053123a6","term":"project","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a6347a834032e09cd828b","term":"projects","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a90e6892dc303f3da3178","term":"Adaptive Multi-Rate","definition":"a lossy audio coding algorithm optimized for speech coding that dynamically adjusts speech bit rate and channel coding to adapt to various network conditions."},{"_id":"645a9325db7c29039d0786cd","term":"Free Lossless Audio Codec","definition":"an open, royalty-free, and efficient audio coding algorithm that can compress audio data to 50-70% of its original size while maintaining its quality, allowing for fast streaming and decoding, and enabling exact recovery of the original data at any time."},{"_id":"645a941b4fb341039ab3df7f","term":"Mu-law","definition":"a lossy audio coding algorithm that reduces the dynamic range of an audio signal by removing data from upper and lower frequencies, compresses audio data to 50% of its original size, and is commonly used as a telecommunication standard in North America and Japan."},{"_id":"645aa6b7def3610ad7f18a44","term":"dataset","definition":"collection of resources that provide a large, representative sample of data that can be transcribed, labeled, and then used to train a model."},{"_id":"645aa83aa3972c0a3a3a7092","term":"Voice Activity Detection (VAD)","definition":"a speech processing technology used to distinguish between speech and non-speech segments of an audio signal. VAD can be used in applications such as speech recognition, voice over IP (VoIP) communication, and audio coding."},{"_id":"645aa902f35aa90ad1f96e17","term":"Lossless","definition":"Class of compression algorithms that allow original data to be perfectly reconstructed from compressed data. Lossless compression is used in cases where deviations from the original data would be unfavorable."},{"_id":"645aa93b1b26f909f49dfd97","term":"Lossy","definition":"Class of compression algorithms that irreversibly degrade data quality to reduce size for storage, handling, and transmission. Well-designed lossy compression technology can significantly reduce file sizes before degradation is noticed by the end-user."},{"_id":"645aaa494bb50c07a38040f9","term":"signed PCM WAV","definition":"a digital audio format that represents analog sound waves by sampling them at regular intervals and encoding the sampled values as binary data, where the signed value indicates whether the sample is positive or negative."},{"_id":"645aab43a30de608fe5d8b6e","term":"encoding","definition":"the different algorithms used to compress digital audio data into a smaller size for efficient storage and transmission, while maintaining the perceptual quality of the original audio signal."},{"_id":"645d5b659f2f6b0623f5e225","term":"model","definition":"an algorithm that is trained to convert spoken language into written text by analyzing large datasets of spoken language and corresponding transcriptions."},{"_id":"645d5b74687a92003052ae6e","term":"resources","definition":"audio file and its associated data, such as a transcription. Resources can be collected into datasets, and a single resource can belong to\n multiple datasets."},{"_id":"64650280ac261d00f6162a01","term":"BCP-47","definition":"BCP-47 describes a syntax, called a \"language-range\", for specifying items in a user's list of language preferences: Read more https://tools.ietf.org/html/bcp47"},{"_id":"646cf5b192603a21458a20cd","term":"Real-Time Messaging Protocol","definition":"Protocol used to stream audio, video, and data over the internet. While RTMP was originally developed by Macromedia to stream between a Flash player and server, it continues to be used as an open-source protocol and is accepted by many streaming providers, such as Zoom."},{"_id":"64e65b60e50a1100654ac5cf","term":"Deprecated","definition":"In software development, \"deprecated\" refers to a feature, function, or practice that is no longer supported or recommended, but still allowed for backward compatibility or other reasons. Deprecated elements are typically marked as such in the software's documentation, and users are advised to avoid using them in new development or to migrate away from them as soon as possible."},{"_id":"65bd5c3b557eb9005625f02d","term":"SDKs","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the Javascript and the Python SDKs."},{"_id":"65c13b0c328f8000421c9980","term":"DSLM","definition":"A Domain-Specific Language Model (DSLM) is a specialized machine learning model designed for a particular domain or task. In contrast to Large Language Models (LLMs), DSLMs are characterized by a narrower scope, with a focus on high accuracy and low latency within a specific context, typically having fewer parameters tailored to the targeted domain."},{"_id":"65c145d74498110031aa2078","term":"TSLM","definition":"A Task-Specific Language Model (TSLM) is a specialized machine learning model fine-tuned for specific tasks. Unlike more broadly applicable Large Language Models (LLMs), TSLMs excel with high accuracy and low latency in their designated areas, boasting a compact architecture optimized for task-specific performance."},{"_id":"66182534818d8400186969da","term":"speex","definition":"Speex is an open-source audio compression format designed for speech applications. Offering variable bit rate modes and support for narrowband and wideband audio, it excels in efficiency and versatility. Its low-latency capabilities make it ideal for real-time communication, while features like noise suppression enhance speech clarity. In summary, Speex provides an effective balance between compression efficiency and audio quality for speech-centric tasks."},{"_id":"661826a16f266c001198833d","term":"G729","definition":"G.729 is a codec designed for low-bandwidth communication, offering efficient speech compression for applications like VoIP. It achieves high compression ratios while maintaining acceptable speech quality, making it ideal for conserving network bandwidth in digital telephony systems."}],"variables":{"user":{},"defaults":[]},"project":{"_id":"6422d7bd2e03b5004c6e088a","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#101014","main_alt":"","header_text":"","body_highlight":"#00E878","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":false,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"dark","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/45785f4-brandmark-blue.svg","readme.svg","60","60","#018EF5"],"loginLogo":[],"logo_white":["https://files.readme.io/c96cd09-Docs_logo.svg","c96cd09-Docs_logo.svg",1123,164,"#ededf2"],"logo_white_use":true,"logo_large":false,"favicon":["https://files.readme.io/f5d488e-small-icon-192x192.png","f5d488e-small-icon-192x192.png",32,32,"#000000","https://files.readme.io/186c0c2-icon-192x192.png"],"stylesheet":"","stylesheet_hub2":"/**\nPlease do not make any changes here. If you need to make styling updates, it \nshould be through our cdn repo. You can find it here:\nhttps://github.com/deepgram-devs/docs-cdn\n*/","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"\n<meta property=\"og:type\" content=\"website\">\n<meta property=\"og:image\" content=\"https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp\">\n<meta property=\"twitter:card\" content=\"summary_large_image\">\n<meta property=\"twitter:image\" content=\"https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp\">\n\n\n<script src=\"https://kit.fontawesome.com/8c4f55fa20.js\" crossorigin=\"anonymous\"></script>\n<link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:100,100i,300,300i,400,400i,500,500i,700,700i,900,900i\" type=\"text/css\">\n\n\n<script src=\"https://deepgram-devs.github.io/docs-cdn/script.js\"></script>\n<link rel=\"stylesheet\" href=\"https://deepgram-devs.github.io/docs-cdn/style.css\" type=\"text/css\">\n<link rel=\"manifest\" href=\"https://deepgram-devs.github.io/docs-cdn/manifest.json\" type=\"application/json\">\n<link rel=\"shortcut icon\" href=\"https://deepgram-devs.github.io/docs-cdn/favicon.ico\" type=\"image/x-icon\">\n\n\n<script nonce=\"{{=it.nonce}}\">\n (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-M5WQMGR');\n</script>\n\n\n\n<script nonce=\"{{=it.nonce}}\">\n window['_fs_debug'] = false;\n window['_fs_host'] = 'fullstory.com';\n window['_fs_script'] = 'edge.fullstory.com/s/fs.js';\n window['_fs_org'] = '5HWAN';\n window['_fs_namespace'] = 'FS';\n (function(m,n,e,t,l,o,g,y){\n if (e in m) {if(m.console && m.console.log) { m.console.log('FullStory namespace conflict. Please set window[\"_fs_namespace\"].');} return;}\n g=m[e]=function(a,b,s){g.q?g.q.push([a,b,s]):g._api(a,b,s);};g.q=[];\n o=n.createElement(t);o.async=1;o.crossOrigin='anonymous';o.src='https://'+_fs_script;\n y=n.getElementsByTagName(t)[0];y.parentNode.insertBefore(o,y);\n g.identify=function(i,v,s){g(l,{uid:i},s);if(v)g(l,v,s)};g.setUserVars=function(v,s){g(l,v,s)};g.event=function(i,v,s){g('event',{n:i,p:v},s)};\n g.anonymize=function(){g.identify(!!0)};\n g.shutdown=function(){g(\"rec\",!1)};g.restart=function(){g(\"rec\",!0)};\n g.log = function(a,b){g(\"log\",[a,b])};\n g.consent=function(a){g(\"consent\",!arguments.length||a)};\n g.identifyAccount=function(i,v){o='account';v=v||{};v.acctId=i;g(o,v)};\n g.clearUserCookie=function(){};\n g.setVars=function(n, p){g('setVars',[n,p]);};\n g._w={};y='XMLHttpRequest';g._w[y]=m[y];y='fetch';g._w[y]=m[y];\n if(m[y])m[y]=function(){return g._w[y].apply(this,arguments)};\n g._v=\"1.3.0\";\n })(window,document,window['_fs_namespace'],'script','user');\n</script>\n\n\n\n<script async\nsrc=\"https://widget.kapa.ai/kapa-widget.bundle.js\"\ndata-user-analytics-fingerprint-enabled=\"true\" \ndata-website-id=\"f5c1c9d4-b072-4c91-8da2-231cc5ea31d2\" \ndata-project-name=\"Deepgram\" \ndata-modal-title=\"Get AI Powered Help Using Deepgram\" \ndata-project-color=\"#EB038F\" \ndata-project-logo=\"https://media.licdn.com/dms/image/D560BAQEaRN1vSzE2Ng/company-logo_200_200/0/1680904416780/deepgram_logo?e=2147483647&v=beta&t=YFDv1MdWVSsq1yknvJ0cD3Acvvi02d6pV1IDiUzA5MA\"\ndata-modal-disclaimer=\"This is a custom LLM for answering questions about Deepgram. Answers are based on the contents of Deepgram's: Documentation, API reference, Code Samples, Help Center and SDKs.\"\n></script>\n","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"reference"},"title":"Deepgram Docs","text":"Explore our guides, resources, and references to build with Deepgram.","_id":"6422d7bd2e03b5004c6e088c"}],"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"developers.deepgram.com","childrenProjects":[],"derivedPlan":"business2018","description":"Deepgram Automatic Speech Recognition helps you build voice applications with better, faster, more economical transcription at scale.","error404":"custom-404-page","experiments":[],"first_page":"docs","flags":{"allowApiExplorerJsonEditor":false,"allowDarkMode":true,"alwaysShowDocPublishStatus":false,"allowXFrame":false,"correctnewlines":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"migrationRun":false,"migrationSwaggerRun":false,"myDevelopers":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"superHub":false,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":true,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":true,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":true,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false},"fullBaseUrl":"https://developers.deepgram.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"6442e552b7accb00668db780","term":"Ogg Opus","definition":"Opus packets encapsulated within Ogg containers, per the original\n Opus specification."},{"_id":"6442e55fc207e2001187d068","term":"Opus","definition":"Lossy audio coding algorithm designed to efficiently code speech\n and general audio in a single format, while remaining low-latency enough for\n real-time interactive communication and low-complexity enough for low-end\n embedded processors. Opus replaces both Vorbis and Speex for new applications,\n and several blind listening tests have ranked it higher quality than any other\n standard audio format at any given bitrate until transparency is reached,\n including MP3, AAC, and HE-AAC. Opus packets may be wrapped in a network\n packet that supplies the packet length. Optionally, a self-delimited packet\n format that adds one or two additional bytes per packet to encode the packet\n length may be used."},{"_id":"6442e58d5d7f9800426dfc8d","term":"Training","definition":"Process through which a machine learning algorithm is fed many\n examples of data and human input to help it identify and replicate a decision\n an expert would make when provided with that same information."},{"_id":"6442e5b0c207e2001187d8ec","term":"Word Error Rate (WER)","definition":"Common metric used to evaluate the effectiveness of automatic\n speech recognition systems (ASRs) and compare the accuracy of the transcripts\n they produce. The more technical, industry-specific, “accented”, and noisy\n your speech data is, the more likely that both ASRs (and humans) will yield a\n high WER."},{"_id":"64552c5bcb2b570034f32764","term":"Community SDK","definition":"An SDK that is not officially maintained by Deepgram, and is maintained by community members instead. The community doesn't necessarily exclude Deepgram team members."},{"_id":"6459336f62d6fe0061e0323e","term":"remote file","definition":"a file that is hosted on a remote server, not one that is on your local machine"},{"_id":"645933a8c1c86b013b4043ce","term":"local file","definition":"a file that is on your local machine, not one that is hosted on a remote server"},{"_id":"645936c0ddc14f00154465cc","term":"transcript","definition":"written text which is the result of converting speech from an audio file into text"},{"_id":"64593adb470f0c000a32f5f4","term":"transcribe","definition":"convert speech from an audio file into written text"},{"_id":"64593da09b499700125d75e7","term":"API","definition":"stands for \"application programming interface\". An API allows two separate IT entities to collaborate using a set of predefined rules for making a request and sending a response between the two entities' servers."},{"_id":"64593eef1b190c0031d1785d","term":"SDK","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the node.js and the python SDKs."},{"_id":"6459421a6dc5be000d33c52d","term":"containerized","definition":"audio stream that contains a header which specifies information about the audio."},{"_id":"645942a0556bf00063fb2c30","term":"raw","definition":"unlike containerized audio formats, raw audio does not contain a header to specify information about the audio."},{"_id":"645948ec8775f20042ddf8ac","term":"VLC","definition":"VLC is a free and open source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols. (https://www.videolan.org/vlc/)"},{"_id":"645949e97bee1100346d71fb","term":"ffmpeg","definition":"a command-line tool that can be used to record, convert, and stream audio and video."},{"_id":"64594c43de5c8f01ca70ed1d","term":"transcription","definition":"Process through which speech in an audio file is converted into written text."},{"_id":"64594eef67091b012b936fca","term":"SRT","definition":"SubRip Text (SRT) is a subtitle format which consists of a sequence of text segments associated with a time-interval. They are plain text files with no metadata, so the files are very small."},{"_id":"64594f1eb198d1003c7aa236","term":"VTT","definition":"WebVTT is a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"64596093f5b18f0725048a99","term":"WebVTT","definition":"a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"6459646f9c4fac05afbd0ddc","term":"tier","definition":"the level of model you would like to use in your request. For example, Deepgram's phonecall model has three tiers: base, enhanced, nova."},{"_id":"645a5e1070f56e2b3d395b1c","term":"streaming","definition":"audio that is delivered through an open channel in a continuous manner, where the audio data is processed bit by bit."},{"_id":"645a5e408f14742bafe7e4a1","term":"pre-recorded","definition":"refers to self-contained audio files such as WAV or MP3 files."},{"_id":"645a62412f762427053123a6","term":"project","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a6347a834032e09cd828b","term":"projects","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a90e6892dc303f3da3178","term":"Adaptive Multi-Rate","definition":"a lossy audio coding algorithm optimized for speech coding that dynamically adjusts speech bit rate and channel coding to adapt to various network conditions."},{"_id":"645a9325db7c29039d0786cd","term":"Free Lossless Audio Codec","definition":"an open, royalty-free, and efficient audio coding algorithm that can compress audio data to 50-70% of its original size while maintaining its quality, allowing for fast streaming and decoding, and enabling exact recovery of the original data at any time."},{"_id":"645a941b4fb341039ab3df7f","term":"Mu-law","definition":"a lossy audio coding algorithm that reduces the dynamic range of an audio signal by removing data from upper and lower frequencies, compresses audio data to 50% of its original size, and is commonly used as a telecommunication standard in North America and Japan."},{"_id":"645aa6b7def3610ad7f18a44","term":"dataset","definition":"collection of resources that provide a large, representative sample of data that can be transcribed, labeled, and then used to train a model."},{"_id":"645aa83aa3972c0a3a3a7092","term":"Voice Activity Detection (VAD)","definition":"a speech processing technology used to distinguish between speech and non-speech segments of an audio signal. VAD can be used in applications such as speech recognition, voice over IP (VoIP) communication, and audio coding."},{"_id":"645aa902f35aa90ad1f96e17","term":"Lossless","definition":"Class of compression algorithms that allow original data to be perfectly reconstructed from compressed data. Lossless compression is used in cases where deviations from the original data would be unfavorable."},{"_id":"645aa93b1b26f909f49dfd97","term":"Lossy","definition":"Class of compression algorithms that irreversibly degrade data quality to reduce size for storage, handling, and transmission. Well-designed lossy compression technology can significantly reduce file sizes before degradation is noticed by the end-user."},{"_id":"645aaa494bb50c07a38040f9","term":"signed PCM WAV","definition":"a digital audio format that represents analog sound waves by sampling them at regular intervals and encoding the sampled values as binary data, where the signed value indicates whether the sample is positive or negative."},{"_id":"645aab43a30de608fe5d8b6e","term":"encoding","definition":"the different algorithms used to compress digital audio data into a smaller size for efficient storage and transmission, while maintaining the perceptual quality of the original audio signal."},{"_id":"645d5b659f2f6b0623f5e225","term":"model","definition":"an algorithm that is trained to convert spoken language into written text by analyzing large datasets of spoken language and corresponding transcriptions."},{"_id":"645d5b74687a92003052ae6e","term":"resources","definition":"audio file and its associated data, such as a transcription. Resources can be collected into datasets, and a single resource can belong to\n multiple datasets."},{"_id":"64650280ac261d00f6162a01","term":"BCP-47","definition":"BCP-47 describes a syntax, called a \"language-range\", for specifying items in a user's list of language preferences: Read more https://tools.ietf.org/html/bcp47"},{"_id":"646cf5b192603a21458a20cd","term":"Real-Time Messaging Protocol","definition":"Protocol used to stream audio, video, and data over the internet. While RTMP was originally developed by Macromedia to stream between a Flash player and server, it continues to be used as an open-source protocol and is accepted by many streaming providers, such as Zoom."},{"_id":"64e65b60e50a1100654ac5cf","term":"Deprecated","definition":"In software development, \"deprecated\" refers to a feature, function, or practice that is no longer supported or recommended, but still allowed for backward compatibility or other reasons. Deprecated elements are typically marked as such in the software's documentation, and users are advised to avoid using them in new development or to migrate away from them as soon as possible."},{"_id":"65bd5c3b557eb9005625f02d","term":"SDKs","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the Javascript and the Python SDKs."},{"_id":"65c13b0c328f8000421c9980","term":"DSLM","definition":"A Domain-Specific Language Model (DSLM) is a specialized machine learning model designed for a particular domain or task. In contrast to Large Language Models (LLMs), DSLMs are characterized by a narrower scope, with a focus on high accuracy and low latency within a specific context, typically having fewer parameters tailored to the targeted domain."},{"_id":"65c145d74498110031aa2078","term":"TSLM","definition":"A Task-Specific Language Model (TSLM) is a specialized machine learning model fine-tuned for specific tasks. Unlike more broadly applicable Large Language Models (LLMs), TSLMs excel with high accuracy and low latency in their designated areas, boasting a compact architecture optimized for task-specific performance."},{"_id":"66182534818d8400186969da","term":"speex","definition":"Speex is an open-source audio compression format designed for speech applications. Offering variable bit rate modes and support for narrowband and wideband audio, it excels in efficiency and versatility. Its low-latency capabilities make it ideal for real-time communication, while features like noise suppression enhance speech clarity. In summary, Speex provides an effective balance between compression efficiency and audio quality for speech-centric tasks."},{"_id":"661826a16f266c001198833d","term":"G729","definition":"G.729 is a codec designed for low-bandwidth communication, offering efficient speech compression for applications like VoIP. It achieves high compression ratios while maintaining acceptable speech quality, making it ideal for conserving network bandwidth in digital telephony systems."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"statusPage","settings":{"page":"psgp8bbm9l61","status":false,"url":""}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":5000000,"thumbsEnabled":true,"monthlyPurchaseLimit":5000000,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true},"name":"Deepgram Docs","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"lastIndexed":"2024-06-14T19:29:13.757Z","customization":{"answerLength":"long","defaultAnswer":"","forbiddenWords":"","tone":"neutral","customTone":""},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":true,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":190},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"6422d7bd2e03b5004c6e088f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0893","6422d7bd2e03b5004c6e089a","64249ca11af6b70060c01043","6424a02a77725700422bd931","6424a3d7348139003e70cceb","6424a3ee348139003e70d0bb","6424a413d75b82003d8f92d0","6424a4f5e2b5be000ad8feb0","6424a5412ec422000a10540b","643961bcd95983001d22375f","643d83a7dfef9d0d500b9d18","643d83b0019f6f0035cab192","643d83b7379fb80d4fcff8f2","643ec43d81d9d40e6e420316","643ec443808a90000a80dd5a","6441165629841e05b46091bb","64412e928a7a28055a7d600e","64493f77eec9471292699395","644f9f168466070049f89ec6","645be9db918e7d0027fc861a","645be9f0a38e0d0142cc95a6","645be9fd918e7d0027fc8a47","645bea05f9b18c0021f4ecf0","645bea0d7a5a290027238f9c","645beca754616e001e365321","645bef89b9c9460026f270e8","6466697af06669003714b160","649fe034e9e70e0037d16c72","64dd0df373eaac0042fc61d9","64dd0e50de07f5004396ced7","64e8dbef77fdce000b621f87","655bd6a1a7dded00572afeb4","6564ca81cf6c370018ccd346","656e38a26a272200770e4a42","65724eaafa82ae0070a29355","65835c6c837d30002a8f700a","6583670921487c000fb1ab21","6583675b77c3a1004eca9150","65836781c0cfb00038820405","6583679878340f005b381b7a","65837404952f290010596a00","6584a321d45d5c005ddc6330","658d655ee44e4a00238ce372","65bd1459a8f9cd0063a614a1","65d7ae457616c60024cbb51c","65d8f59e948bdb002f4e1fff","65de216884e02c006039c4e1","66050ca0294a25002b032088","6670aace1dfc1c007642c46f","66b302b66c773d0025da67df","66ccdad55d5add0062424f08","66ccde4f4db0a00019aea808","671694a7bd44f5004ced168a","67180693b1bffb0054dfa424"],"project":"6422d7bd2e03b5004c6e088a","releaseDate":"2023-03-28T12:04:13.477Z","createdAt":"2023-03-28T12:04:13.477Z","__v":1,"updatedAt":"2024-10-22T20:09:55.913Z"},"subdomain":"api-beta-deepgram","subpath":"","superHubWaitlist":true,"topnav":{"left":[],"right":[{"type":"url","url":"https://console.deepgram.com/signup?jump=keys","text":"Free API Key"}],"bottom":[{"type":"url","page":"community","text":"Community","url":"https://community.deepgram.com/"},{"type":"url","text":"API Playground","url":"https://playground.deepgram.com"},{"type":"url","text":"Blog","url":"https://deepgram.com/learn"},{"type":"url","text":"Status","url":"https://status.deepgram.com/"}],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2023-04-11T12:04:13.133Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://deepgram.com","versions":[{"_id":"6422d7bd2e03b5004c6e088f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0893","6422d7bd2e03b5004c6e089a","64249ca11af6b70060c01043","6424a02a77725700422bd931","6424a3d7348139003e70cceb","6424a3ee348139003e70d0bb","6424a413d75b82003d8f92d0","6424a4f5e2b5be000ad8feb0","6424a5412ec422000a10540b","643961bcd95983001d22375f","643d83a7dfef9d0d500b9d18","643d83b0019f6f0035cab192","643d83b7379fb80d4fcff8f2","643ec43d81d9d40e6e420316","643ec443808a90000a80dd5a","6441165629841e05b46091bb","64412e928a7a28055a7d600e","64493f77eec9471292699395","644f9f168466070049f89ec6","645be9db918e7d0027fc861a","645be9f0a38e0d0142cc95a6","645be9fd918e7d0027fc8a47","645bea05f9b18c0021f4ecf0","645bea0d7a5a290027238f9c","645beca754616e001e365321","645bef89b9c9460026f270e8","6466697af06669003714b160","649fe034e9e70e0037d16c72","64dd0df373eaac0042fc61d9","64dd0e50de07f5004396ced7","64e8dbef77fdce000b621f87","655bd6a1a7dded00572afeb4","6564ca81cf6c370018ccd346","656e38a26a272200770e4a42","65724eaafa82ae0070a29355","65835c6c837d30002a8f700a","6583670921487c000fb1ab21","6583675b77c3a1004eca9150","65836781c0cfb00038820405","6583679878340f005b381b7a","65837404952f290010596a00","6584a321d45d5c005ddc6330","658d655ee44e4a00238ce372","65bd1459a8f9cd0063a614a1","65d7ae457616c60024cbb51c","65d8f59e948bdb002f4e1fff","65de216884e02c006039c4e1","66050ca0294a25002b032088","6670aace1dfc1c007642c46f","66b302b66c773d0025da67df","66ccdad55d5add0062424f08","66ccde4f4db0a00019aea808","671694a7bd44f5004ced168a","67180693b1bffb0054dfa424"],"project":"6422d7bd2e03b5004c6e088a","releaseDate":"2023-03-28T12:04:13.477Z","createdAt":"2023-03-28T12:04:13.477Z","__v":1,"updatedAt":"2024-10-22T20:09:55.913Z"}],"variableDefaults":[null],"webhookEnabled":true,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"6442e552b7accb00668db780","term":"Ogg Opus","definition":"Opus packets encapsulated within Ogg containers, per the original\n Opus specification."},{"_id":"6442e55fc207e2001187d068","term":"Opus","definition":"Lossy audio coding algorithm designed to efficiently code speech\n and general audio in a single format, while remaining low-latency enough for\n real-time interactive communication and low-complexity enough for low-end\n embedded processors. Opus replaces both Vorbis and Speex for new applications,\n and several blind listening tests have ranked it higher quality than any other\n standard audio format at any given bitrate until transparency is reached,\n including MP3, AAC, and HE-AAC. Opus packets may be wrapped in a network\n packet that supplies the packet length. Optionally, a self-delimited packet\n format that adds one or two additional bytes per packet to encode the packet\n length may be used."},{"_id":"6442e58d5d7f9800426dfc8d","term":"Training","definition":"Process through which a machine learning algorithm is fed many\n examples of data and human input to help it identify and replicate a decision\n an expert would make when provided with that same information."},{"_id":"6442e5b0c207e2001187d8ec","term":"Word Error Rate (WER)","definition":"Common metric used to evaluate the effectiveness of automatic\n speech recognition systems (ASRs) and compare the accuracy of the transcripts\n they produce. The more technical, industry-specific, “accented”, and noisy\n your speech data is, the more likely that both ASRs (and humans) will yield a\n high WER."},{"_id":"64552c5bcb2b570034f32764","term":"Community SDK","definition":"An SDK that is not officially maintained by Deepgram, and is maintained by community members instead. The community doesn't necessarily exclude Deepgram team members."},{"_id":"6459336f62d6fe0061e0323e","term":"remote file","definition":"a file that is hosted on a remote server, not one that is on your local machine"},{"_id":"645933a8c1c86b013b4043ce","term":"local file","definition":"a file that is on your local machine, not one that is hosted on a remote server"},{"_id":"645936c0ddc14f00154465cc","term":"transcript","definition":"written text which is the result of converting speech from an audio file into text"},{"_id":"64593adb470f0c000a32f5f4","term":"transcribe","definition":"convert speech from an audio file into written text"},{"_id":"64593da09b499700125d75e7","term":"API","definition":"stands for \"application programming interface\". An API allows two separate IT entities to collaborate using a set of predefined rules for making a request and sending a response between the two entities' servers."},{"_id":"64593eef1b190c0031d1785d","term":"SDK","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the node.js and the python SDKs."},{"_id":"6459421a6dc5be000d33c52d","term":"containerized","definition":"audio stream that contains a header which specifies information about the audio."},{"_id":"645942a0556bf00063fb2c30","term":"raw","definition":"unlike containerized audio formats, raw audio does not contain a header to specify information about the audio."},{"_id":"645948ec8775f20042ddf8ac","term":"VLC","definition":"VLC is a free and open source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols. (https://www.videolan.org/vlc/)"},{"_id":"645949e97bee1100346d71fb","term":"ffmpeg","definition":"a command-line tool that can be used to record, convert, and stream audio and video."},{"_id":"64594c43de5c8f01ca70ed1d","term":"transcription","definition":"Process through which speech in an audio file is converted into written text."},{"_id":"64594eef67091b012b936fca","term":"SRT","definition":"SubRip Text (SRT) is a subtitle format which consists of a sequence of text segments associated with a time-interval. They are plain text files with no metadata, so the files are very small."},{"_id":"64594f1eb198d1003c7aa236","term":"VTT","definition":"WebVTT is a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"64596093f5b18f0725048a99","term":"WebVTT","definition":"a subtitle format which consists of a sequence of text segments associated with a time-interval, called a cue. WebVTT was created to work with HTML5, which means the cues can easily be styled with CSS."},{"_id":"6459646f9c4fac05afbd0ddc","term":"tier","definition":"the level of model you would like to use in your request. For example, Deepgram's phonecall model has three tiers: base, enhanced, nova."},{"_id":"645a5e1070f56e2b3d395b1c","term":"streaming","definition":"audio that is delivered through an open channel in a continuous manner, where the audio data is processed bit by bit."},{"_id":"645a5e408f14742bafe7e4a1","term":"pre-recorded","definition":"refers to self-contained audio files such as WAV or MP3 files."},{"_id":"645a62412f762427053123a6","term":"project","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a6347a834032e09cd828b","term":"projects","definition":"Deepgram accounts can contain one or more projects, which are distinct environments with a set of users, a set of API keys, and separate billing and monitoring."},{"_id":"645a90e6892dc303f3da3178","term":"Adaptive Multi-Rate","definition":"a lossy audio coding algorithm optimized for speech coding that dynamically adjusts speech bit rate and channel coding to adapt to various network conditions."},{"_id":"645a9325db7c29039d0786cd","term":"Free Lossless Audio Codec","definition":"an open, royalty-free, and efficient audio coding algorithm that can compress audio data to 50-70% of its original size while maintaining its quality, allowing for fast streaming and decoding, and enabling exact recovery of the original data at any time."},{"_id":"645a941b4fb341039ab3df7f","term":"Mu-law","definition":"a lossy audio coding algorithm that reduces the dynamic range of an audio signal by removing data from upper and lower frequencies, compresses audio data to 50% of its original size, and is commonly used as a telecommunication standard in North America and Japan."},{"_id":"645aa6b7def3610ad7f18a44","term":"dataset","definition":"collection of resources that provide a large, representative sample of data that can be transcribed, labeled, and then used to train a model."},{"_id":"645aa83aa3972c0a3a3a7092","term":"Voice Activity Detection (VAD)","definition":"a speech processing technology used to distinguish between speech and non-speech segments of an audio signal. VAD can be used in applications such as speech recognition, voice over IP (VoIP) communication, and audio coding."},{"_id":"645aa902f35aa90ad1f96e17","term":"Lossless","definition":"Class of compression algorithms that allow original data to be perfectly reconstructed from compressed data. Lossless compression is used in cases where deviations from the original data would be unfavorable."},{"_id":"645aa93b1b26f909f49dfd97","term":"Lossy","definition":"Class of compression algorithms that irreversibly degrade data quality to reduce size for storage, handling, and transmission. Well-designed lossy compression technology can significantly reduce file sizes before degradation is noticed by the end-user."},{"_id":"645aaa494bb50c07a38040f9","term":"signed PCM WAV","definition":"a digital audio format that represents analog sound waves by sampling them at regular intervals and encoding the sampled values as binary data, where the signed value indicates whether the sample is positive or negative."},{"_id":"645aab43a30de608fe5d8b6e","term":"encoding","definition":"the different algorithms used to compress digital audio data into a smaller size for efficient storage and transmission, while maintaining the perceptual quality of the original audio signal."},{"_id":"645d5b659f2f6b0623f5e225","term":"model","definition":"an algorithm that is trained to convert spoken language into written text by analyzing large datasets of spoken language and corresponding transcriptions."},{"_id":"645d5b74687a92003052ae6e","term":"resources","definition":"audio file and its associated data, such as a transcription. Resources can be collected into datasets, and a single resource can belong to\n multiple datasets."},{"_id":"64650280ac261d00f6162a01","term":"BCP-47","definition":"BCP-47 describes a syntax, called a \"language-range\", for specifying items in a user's list of language preferences: Read more https://tools.ietf.org/html/bcp47"},{"_id":"646cf5b192603a21458a20cd","term":"Real-Time Messaging Protocol","definition":"Protocol used to stream audio, video, and data over the internet. While RTMP was originally developed by Macromedia to stream between a Flash player and server, it continues to be used as an open-source protocol and is accepted by many streaming providers, such as Zoom."},{"_id":"64e65b60e50a1100654ac5cf","term":"Deprecated","definition":"In software development, \"deprecated\" refers to a feature, function, or practice that is no longer supported or recommended, but still allowed for backward compatibility or other reasons. Deprecated elements are typically marked as such in the software's documentation, and users are advised to avoid using them in new development or to migrate away from them as soon as possible."},{"_id":"65bd5c3b557eb9005625f02d","term":"SDKs","definition":"stands for \"software development kit\". SDKs are tools that make it easier for developers to work with an API using a specific programming language. Deepgram has several officially supported SDKs such as the Javascript and the Python SDKs."},{"_id":"65c13b0c328f8000421c9980","term":"DSLM","definition":"A Domain-Specific Language Model (DSLM) is a specialized machine learning model designed for a particular domain or task. In contrast to Large Language Models (LLMs), DSLMs are characterized by a narrower scope, with a focus on high accuracy and low latency within a specific context, typically having fewer parameters tailored to the targeted domain."},{"_id":"65c145d74498110031aa2078","term":"TSLM","definition":"A Task-Specific Language Model (TSLM) is a specialized machine learning model fine-tuned for specific tasks. Unlike more broadly applicable Large Language Models (LLMs), TSLMs excel with high accuracy and low latency in their designated areas, boasting a compact architecture optimized for task-specific performance."},{"_id":"66182534818d8400186969da","term":"speex","definition":"Speex is an open-source audio compression format designed for speech applications. Offering variable bit rate modes and support for narrowband and wideband audio, it excels in efficiency and versatility. Its low-latency capabilities make it ideal for real-time communication, while features like noise suppression enhance speech clarity. In summary, Speex provides an effective balance between compression efficiency and audio quality for speech-centric tasks."},{"_id":"661826a16f266c001198833d","term":"G729","definition":"G.729 is a codec designed for low-bandwidth communication, offering efficient speech compression for applications like VoIP. It achieves high compression ratios while maintaining acceptable speech quality, making it ideal for conserving network bandwidth in digital telephony systems."}],"canonical_url":null,"description":"Deepgram Automatic Speech Recognition helps you build voice applications with better, faster, more economical transcription at scale.","homepage_url":"https://deepgram.com","id":"6422d7bd2e03b5004c6e088a","name":"Deepgram Docs","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"api-beta-deepgram","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":"/versions/stable/custom_pages/custom-404-page"},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"disabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2023-04-11T12:04:13.133Z"}},"health_check":{"provider":"statuspage","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":"psgp8bbm9l61"}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#101014","link_color":"#00E878","theme":"dark"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/c96cd09-Docs_logo.svg","name":"c96cd09-Docs_logo.svg","width":1123,"height":164,"color":"#ededf2","links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/45785f4-brandmark-blue.svg","name":"readme.svg","width":60,"height":60,"color":"#018EF5","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/f5d488e-small-icon-192x192.png","name":"f5d488e-small-icon-192x192.png","width":32,"height":32,"color":"#000000","links":{"original_url":"https://files.readme.io/186c0c2-icon-192x192.png"}}},"custom_code":{"css":"/**\nPlease do not make any changes here. If you need to make styling updates, it \nshould be through our cdn repo. You can find it here:\nhttps://github.com/deepgram-devs/docs-cdn\n*/","js":null,"html":{"header":"\n<meta property=\"og:type\" content=\"website\">\n<meta property=\"og:image\" content=\"https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp\">\n<meta property=\"twitter:card\" content=\"summary_large_image\">\n<meta property=\"twitter:image\" content=\"https://deepgram-devs.github.io/docs-cdn/deepgram-opengraph.webp\">\n\n\n<script src=\"https://kit.fontawesome.com/8c4f55fa20.js\" crossorigin=\"anonymous\"></script>\n<link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:100,100i,300,300i,400,400i,500,500i,700,700i,900,900i\" type=\"text/css\">\n\n\n<script src=\"https://deepgram-devs.github.io/docs-cdn/script.js\"></script>\n<link rel=\"stylesheet\" href=\"https://deepgram-devs.github.io/docs-cdn/style.css\" type=\"text/css\">\n<link rel=\"manifest\" href=\"https://deepgram-devs.github.io/docs-cdn/manifest.json\" type=\"application/json\">\n<link rel=\"shortcut icon\" href=\"https://deepgram-devs.github.io/docs-cdn/favicon.ico\" type=\"image/x-icon\">\n\n\n<script nonce=\"{{=it.nonce}}\">\n (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-M5WQMGR');\n</script>\n\n\n\n<script nonce=\"{{=it.nonce}}\">\n window['_fs_debug'] = false;\n window['_fs_host'] = 'fullstory.com';\n window['_fs_script'] = 'edge.fullstory.com/s/fs.js';\n window['_fs_org'] = '5HWAN';\n window['_fs_namespace'] = 'FS';\n (function(m,n,e,t,l,o,g,y){\n if (e in m) {if(m.console && m.console.log) { m.console.log('FullStory namespace conflict. Please set window[\"_fs_namespace\"].');} return;}\n g=m[e]=function(a,b,s){g.q?g.q.push([a,b,s]):g._api(a,b,s);};g.q=[];\n o=n.createElement(t);o.async=1;o.crossOrigin='anonymous';o.src='https://'+_fs_script;\n y=n.getElementsByTagName(t)[0];y.parentNode.insertBefore(o,y);\n g.identify=function(i,v,s){g(l,{uid:i},s);if(v)g(l,v,s)};g.setUserVars=function(v,s){g(l,v,s)};g.event=function(i,v,s){g('event',{n:i,p:v},s)};\n g.anonymize=function(){g.identify(!!0)};\n g.shutdown=function(){g(\"rec\",!1)};g.restart=function(){g(\"rec\",!0)};\n g.log = function(a,b){g(\"log\",[a,b])};\n g.consent=function(a){g(\"consent\",!arguments.length||a)};\n g.identifyAccount=function(i,v){o='account';v=v||{};v.acctId=i;g(o,v)};\n g.clearUserCookie=function(){};\n g.setVars=function(n, p){g('setVars',[n,p]);};\n g._w={};y='XMLHttpRequest';g._w[y]=m[y];y='fetch';g._w[y]=m[y];\n if(m[y])m[y]=function(){return g._w[y].apply(this,arguments)};\n g._v=\"1.3.0\";\n })(window,document,window['_fs_namespace'],'script','user');\n</script>\n\n\n\n<script async\nsrc=\"https://widget.kapa.ai/kapa-widget.bundle.js\"\ndata-user-analytics-fingerprint-enabled=\"true\" \ndata-website-id=\"f5c1c9d4-b072-4c91-8da2-231cc5ea31d2\" \ndata-project-name=\"Deepgram\" \ndata-modal-title=\"Get AI Powered Help Using Deepgram\" \ndata-project-color=\"#EB038F\" \ndata-project-logo=\"https://media.licdn.com/dms/image/D560BAQEaRN1vSzE2Ng/company-logo_200_200/0/1680904416780/deepgram_logo?e=2147483647&v=beta&t=YFDv1MdWVSsq1yknvJ0cD3Acvvi02d6pV1IDiUzA5MA\"\ndata-modal-disclaimer=\"This is a custom LLM for answering questions about Deepgram. Answers are based on the contents of Deepgram's: Documentation, API reference, Code Samples, Help Center and SDKs.\"\n></script>\n","home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"documentation","left":[],"logo_link":"landing_page","right":[{"type":"link_url","title":"Free API Key","url":"https://console.deepgram.com/signup?jump=keys","custom_page":null}],"sub_nav":[{"type":"link_url","title":"Community","url":"https://community.deepgram.com/","custom_page":"community"},{"type":"link_url","title":"API Playground","url":"https://playground.deepgram.com","custom_page":null},{"type":"link_url","title":"Blog","url":"https://deepgram.com/learn","custom_page":null},{"type":"link_url","title":"Status","url":"https://status.deepgram.com/","custom_page":null}],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Documentation","visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"enabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"6422d7bd2e03b5004c6e088f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0893","6422d7bd2e03b5004c6e089a","64249ca11af6b70060c01043","6424a02a77725700422bd931","6424a3d7348139003e70cceb","6424a3ee348139003e70d0bb","6424a413d75b82003d8f92d0","6424a4f5e2b5be000ad8feb0","6424a5412ec422000a10540b","643961bcd95983001d22375f","643d83a7dfef9d0d500b9d18","643d83b0019f6f0035cab192","643d83b7379fb80d4fcff8f2","643ec43d81d9d40e6e420316","643ec443808a90000a80dd5a","6441165629841e05b46091bb","64412e928a7a28055a7d600e","64493f77eec9471292699395","644f9f168466070049f89ec6","645be9db918e7d0027fc861a","645be9f0a38e0d0142cc95a6","645be9fd918e7d0027fc8a47","645bea05f9b18c0021f4ecf0","645bea0d7a5a290027238f9c","645beca754616e001e365321","645bef89b9c9460026f270e8","6466697af06669003714b160","649fe034e9e70e0037d16c72","64dd0df373eaac0042fc61d9","64dd0e50de07f5004396ced7","64e8dbef77fdce000b621f87","655bd6a1a7dded00572afeb4","6564ca81cf6c370018ccd346","656e38a26a272200770e4a42","65724eaafa82ae0070a29355","65835c6c837d30002a8f700a","6583670921487c000fb1ab21","6583675b77c3a1004eca9150","65836781c0cfb00038820405","6583679878340f005b381b7a","65837404952f290010596a00","6584a321d45d5c005ddc6330","658d655ee44e4a00238ce372","65bd1459a8f9cd0063a614a1","65d7ae457616c60024cbb51c","65d8f59e948bdb002f4e1fff","65de216884e02c006039c4e1","66050ca0294a25002b032088","6670aace1dfc1c007642c46f","66b302b66c773d0025da67df","66ccdad55d5add0062424f08","66ccde4f4db0a00019aea808","671694a7bd44f5004ced168a","67180693b1bffb0054dfa424"],"project":"6422d7bd2e03b5004c6e088a","releaseDate":"2023-03-28T12:04:13.477Z","createdAt":"2023-03-28T12:04:13.477Z","__v":1,"updatedAt":"2024-10-22T20:09:55.913Z"}},"reqUrl":"/docs/self-hosted-self-service-tutorial","version":{"_id":"6422d7bd2e03b5004c6e088f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0891","6422d7bd2e03b5004c6e0893","6422d7bd2e03b5004c6e089a","64249ca11af6b70060c01043","6424a02a77725700422bd931","6424a3d7348139003e70cceb","6424a3ee348139003e70d0bb","6424a413d75b82003d8f92d0","6424a4f5e2b5be000ad8feb0","6424a5412ec422000a10540b","643961bcd95983001d22375f","643d83a7dfef9d0d500b9d18","643d83b0019f6f0035cab192","643d83b7379fb80d4fcff8f2","643ec43d81d9d40e6e420316","643ec443808a90000a80dd5a","6441165629841e05b46091bb","64412e928a7a28055a7d600e","64493f77eec9471292699395","644f9f168466070049f89ec6","645be9db918e7d0027fc861a","645be9f0a38e0d0142cc95a6","645be9fd918e7d0027fc8a47","645bea05f9b18c0021f4ecf0","645bea0d7a5a290027238f9c","645beca754616e001e365321","645bef89b9c9460026f270e8","6466697af06669003714b160","649fe034e9e70e0037d16c72","64dd0df373eaac0042fc61d9","64dd0e50de07f5004396ced7","64e8dbef77fdce000b621f87","655bd6a1a7dded00572afeb4","6564ca81cf6c370018ccd346","656e38a26a272200770e4a42","65724eaafa82ae0070a29355","65835c6c837d30002a8f700a","6583670921487c000fb1ab21","6583675b77c3a1004eca9150","65836781c0cfb00038820405","6583679878340f005b381b7a","65837404952f290010596a00","6584a321d45d5c005ddc6330","658d655ee44e4a00238ce372","65bd1459a8f9cd0063a614a1","65d7ae457616c60024cbb51c","65d8f59e948bdb002f4e1fff","65de216884e02c006039c4e1","66050ca0294a25002b032088","6670aace1dfc1c007642c46f","66b302b66c773d0025da67df","66ccdad55d5add0062424f08","66ccde4f4db0a00019aea808","671694a7bd44f5004ced168a","67180693b1bffb0054dfa424"],"project":"6422d7bd2e03b5004c6e088a","releaseDate":"2023-03-28T12:04:13.477Z","createdAt":"2023-03-28T12:04:13.477Z","__v":1,"updatedAt":"2024-10-22T20:09:55.913Z"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>window.heap=window.heap||[],heap.load=function(e,t){window.heap.appid=e,window.heap.config=t=t||{};var n="https:"===document.location.protocol,a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src=(n?"https:":"http:")+"//cdn.heapanalytics.com/js/heap-"+e+".js";var o=document.getElementsByTagName("script")[0];o.parentNode.insertBefore(a,o);for(var r=function(e){return function(){heap.push([e].concat(Array.prototype.slice.call(arguments,0)))}},p=["clearEventProperties","identify","setEventProperties","track","unsetEventProperty"],c=0;c<p.length;c++)heap[p[c]]=r(p[c])}; heap.load("765739241"); </script><script>!function(t){if(window.ko)return;window.ko=[],["identify","track", "removeListeners", "open", "on", "off", "qualify", "ready"].forEach(function(t){ko[t]=function(){var n=[].slice.call(arguments);return n.unshift(t),ko.push(n),ko}});var n=document.createElement("script");n.async=!0,n.setAttribute("src","https://cdn.getkoala.com/v1/pk_5d224a7d4d15f263fc33fcad6162fdb5ff81/sdk.js"),(document.body || document.head).appendChild(n)}(); $(window).on('pageLoad', function(e, state){ try { const me = JSON.parse(document.getElementById('hub-me').dataset.json); const email = me.user && me.user.email; if (email) { ko.identify(email); } } catch (e) {} });</script><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,734,5312,6903,2395,6522,697,73,777,3108,2852,9930,7783,1456,1666,5798,4935,4287,4201,1936,4002,3906,3787,9553,153,1313,1202,3859,9575,1343,6060,6922,2447,2144,9141,8063,5408,2637,4674,1731,2616,3412,3221,7327,7285,3307,1948,1080,9852,8684]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-PageNotFound","Footer","core-icons-chevron-up-down-svg","routes-Doc","routes-Landing","routes-Reference","core-icons-alert-circle-svg","core-icons-chevron-down-svg","core-icons-arrow-right-svg","core-icons-more-vertical-svg","core-icons-lock-svg","CustomPage","routes-Changelog","Post","core-icons-arrow-up-right-svg","routes-Discuss","List","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","routes-CustomPage","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.ad529c3d39e40f72e3f8.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.684e6481786a2c9a53de.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.e8c079b3df984cab2b40.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.b705fc2010420612d252.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.5f04db368eee8f70d81b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/697.c7df71558ebc8a75b523.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/73.c91a16995ea193a8705d.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/777.62bdcb0e49d755651783.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3108.471d4a1c3077afe27478.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.c1a2ae7970da644925ea.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.f038db7b1e3ac1460fe5.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.21bfe108dc2a9fd8187f.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.9d9eb8df4877b777c42d.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.9802bfeceb2dceb6e206.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.0a317d4e2bf3cde90317.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.cef380c3e211d2ea6e51.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.979bb00f878b2fa579a6.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/3906.62f576269c8b3253048f.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.3ccf9f42effebdfd9cbf.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/9553.cb407a77300a2dd958e4.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e58189ce91340b95c433.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d035c3329df9585fa7d6.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.b74c02c4ec3b054bb9d5.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.071c7febd301fb6e2a4d.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.c5776db0e83892adab6f.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.2deb29c12d09bcad8fb2.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.879f8fb13a34fcccd2a3.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.05c5c00809eab74a8061.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.e0529587af8819bc68f0.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.2edfa94f1d90a641f339.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.54cd06e135d3ee0dbc93.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"ZjEzOTc3NzNkNmYwNTQ2MzZlMDE0MzA1ZmYxN2JiMDNlNTdhMDBmYTFhNDIwZmIwOTNkYTJmYWQ5Mzc1MzZiMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjQyMmQ3YmQyZTAzYjUwMDRjNmUwODhhKSwodmVyc2lvbjpub25lLHZlcnNpb246NjQyMmQ3YmQyZTAzYjUwMDRjNmUwODhmKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OlR1dG9yaWFsKQ==","filters":"tagFilters=(project:6422d7bd2e03b5004c6e088a),(version:none,version:6422d7bd2e03b5004c6e088f),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Tutorial)","metaData":[{"modules":{"landing":false,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true},"id":"6422d7bd2e03b5004c6e088a","name":"Deepgram Docs","subdomain":"api-beta-deepgram","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

Self Service Licensing & Credentials