examples/default.html
<!DOCTYPE html><meta charset=utf-8><title>Speech to Text</title><link rel=stylesheet href=https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css><style>@import url(https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200);.hljs-comment,.hljs-title{color:#8e908c}.css .hljs-class,.css .hljs-id,.css .hljs-pseudo,.hljs-attribute,.hljs-regexp,.hljs-tag,.hljs-variable,.html .hljs-doctype,.ruby .hljs-constant,.xml .hljs-doctype,.xml .hljs-pi,.xml .hljs-tag .hljs-title{color:#c82829}.hljs-built_in,.hljs-constant,.hljs-literal,.hljs-number,.hljs-params,.hljs-pragma,.hljs-preprocessor{color:#f5871f}.css .hljs-rules .hljs-attribute,.ruby .hljs-class .hljs-title{color:#eab700}.hljs-header,.hljs-inheritance,.hljs-string,.hljs-value,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.coffeescript .hljs-title,.hljs-function,.javascript .hljs-title,.perl .hljs-sub,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:#fff;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .css,.xml .hljs-cdata,.xml .javascript,.xml .vbscript{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:#000;background:#fff;font:400 14px/1.42 Roboto,Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:#000;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px Raleway,Helvetica,sans-serif;font-size:36px}h2{font:200 36px Raleway,Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:400}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right,rgba(0,0,0,0) 20%,rgba(0,0,0,.2) 51.4%,rgba(255,255,255,.2) 51.4%,rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:#000;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:Inconsolata,monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ol,ul{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table td,table th{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6,.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{font-family:200 36px Raleway,Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:#000;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:#000;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:#000;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid #000}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid #000}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none!important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:after,.middle:before{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right div,.right h1,.right h2,.right h3,.right h4,.right h5,.right p{color:#fff}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:700}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:#000;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:#fff;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,.5);background-color:#f2f2f2;text-decoration:none!important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:#fff;border:1px solid #d9d9d9;border-radius:6px}.resource-group .heading a,.resource-group h2.group-heading{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group .heading a,.triple .content .resource-group h2.group-heading{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:400;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:400;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid #fff;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style><style>.heading a{font-size:1.2em}p img{width:100%}dd p{margin:.5em 0}p{line-height:150%}code{padding:0 .25em;margin:0}</style><body class=preload><a href=#top class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class=container><div class=row><nav><div class=resource-group><div class=heading><div class=chevron><i class="open fa fa-angle-down"></i></div><a href=#top>Overview</a></div><div class=collapse-content><ul><li><a href=#header-service-overview>Service Overview</a><li><a href=#header-api-overview>API Overview</a><li><a href=#header-api-usage>API Usage</a></ul></div></div><div class=resource-group><div class=heading><div class=chevron><i class="open fa fa-angle-down"></i></div><a href=#models>models</a></div><div class=collapse-content><ul><li><a href=#models-get><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieves the models available for the service</a><li><a href=#models-get-1><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieves information about the model</a></ul></div></div><div class=resource-group><div class=heading><div class=chevron><i class="open fa fa-angle-down"></i></div><a href=#sessions>sessions</a></div><div class=collapse-content><ul><li><a href=#sessions-creates-a-session-post><span class="badge post"><i class="fa fa-plus"></i></span>Creates a session</a><li><li><a href=#sessions-delete><span class="badge delete"><i class="fa fa-times"></i></span>Deletes the specified session</a><li><a href=#sessions-get><span class="badge get"><i class="fa fa-arrow-down"></i></span>Observes results for a recognition task within a session</a><li><li><a href=#sessions-get-1><span class="badge get"><i class="fa fa-arrow-down"></i></span>Checks whether a session is ready to accept a new recognition task</a><li><a href=#sessions-post><span class="badge post"><i class="fa fa-plus"></i></span>Sends audio for speech recognition within a session</a></ul></div></div><div class=resource-group><div class=heading><div class=chevron><i class="open fa fa-angle-down"></i></div><a href=#sessionless>sessionless</a></div><div class=collapse-content><ul><li><a href=#sessionless-sends-audio-for-speech-recognition-in-sessionless-mode-post><span class="badge post"><i class="fa fa-plus"></i></span>Sends audio for speech recognition in sessionless mode</a></ul></div></div><div class=resource-group><div class=heading><div class=chevron><i class="open fa fa-angle-down"></i></div><a href=#asynchronous>asynchronous</a></div><div class=collapse-content><ul><li><a href=#asynchronous-registers-a-callback-url-for-use-with-the-asynchronous-interface-post><span class="badge post"><i class="fa fa-plus"></i></span>Registers a callback URL for use with the asynchronous interface</a><li><li><a href=#asynchronous-get><span class="badge get"><i class="fa fa-arrow-down"></i></span>Checks the status of all asynchronous jobs</a><li><a href=#asynchronous-post><span class="badge post"><i class="fa fa-plus"></i></span>Creates a job for an asynchronous recognition request</a><li><li><a href=#asynchronous-delete><span class="badge delete"><i class="fa fa-times"></i></span>Deletes the specified asynchronous job</a><li><a href=#asynchronous-get-1><span class="badge get"><i class="fa fa-arrow-down"></i></span>Checks the status of the specified asynchronous job</a></ul></div></div></nav><div class=content><header><h1 id=top>Speech to Text</h1></header><h3 id=header-service-overview>Service Overview <a class=permalink href=#header-service-overview aria-hidden=true>¶</a></h3><p>The IBM Speech to Text service provides a Representational State Transfer (REST) Application Programming Interface (API) that enables you to add IBM’s speech transcription capabilities to your applications. The service also supports an asynchronous HTTP interface for transcribing audio via non-blocking calls. The service transcribes speech from various languages and audio formats to text with low latency. The service supports transcription of the following languages: Brazilian Portuguese, Japanese, Mandarin Chinese, Modern Standard Arabic, Spanish, UK English, and US English. For most languages, the service supports two sampling rates, broadband and narrowband.<h3 id=header-api-overview>API Overview <a class=permalink href=#header-api-overview aria-hidden=true>¶</a></h3><p>The Speech to Text service provides the following endpoints:<ul><li><p><code>/v1/models</code> returns information about the models (languages and sampling rates) available for transcription.<li><p><code>/v1/sessions</code> provides a collection of methods that provide a mechanism for a client to maintain a long, multi-turn exchange, or session, with the service or to establish multiple parallel conversations with a particular instance of the service.<li><p><code>/v1/recognize</code> (sessionless) includes a single method that provides a simple means of transcribing audio without the overhead of establishing and maintaining a session, but it lacks some of the capabilities available with sessions.<li><p><code>/v1/register_callback</code> (asynchronous) offers a single method that registers, or white-lists, a callback URL for use with methods of the asynchronous HTTP interface.<li><p><code>/v1/recognitions</code> (asynchronous) provides a set of non-blocking methods for submitting, querying, and deleting jobs for recognition requests with the asynchronous HTTP interface.</ul><h3 id=header-api-usage>API Usage <a class=permalink href=#header-api-usage aria-hidden=true>¶</a></h3><p>The following general information pertains to the transcription of audio:<ul><li><p>You can pass the audio to be transcribed as a one-shot delivery or in streaming mode. With one-shot delivery, you pass all of the audio data to the service at one time. With streaming mode, you send audio data to the service in chunks over a persistent connection. If your data consists of multiple parts, you must stream the data. To use streaming, you must pass the <code>Transfer-Encoding</code> request header with a value of <code>chunked</code>. Both forms of data transmission impose a limit of 100 MB of total data for transcription.<li><p>You can use methods of the session-based, sessionless, or asynchronous HTTP interfaces to pass audio data to the service. All interfaces let you send the data via the body of the request; the session-based and sessionless methods also let you pass data in the form of one or more audio files as multipart form data. With the former approach, you control the transcription via a collection of request headers and query parameters. With the latter, you control the transcription primarily via JSON metadata sent as form data.<li><p>The service also offers a WebSocket interface as an alternative to its HTTP interfaces. The WebSocket interface supports efficient implementation, lower latency, and higher throughput. The interface establishes a persistent connection with the service, eliminating the need for session-based calls from the HTTP interface.<li><p>By default, all Watson services log requests and their results. Data is collected only to improve the Watson services. If you do not want to share your data, set the header parameter <code>X-Watson-Learning-Opt-Out</code> to <code>true</code> for each request. Data is collected for any request that omits this header.</ul><p>For more information about using the Speech to Text service and the various interfaces it supports, see <a target=_blank href=http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/speech-to-text/ >Using the Speech to Text service</a>.<section id=models class=resource-group><h2 class=group-heading>models <a href=#models class=permalink>¶</a></h2><div id=models- class=resource><div id=models-get class="action get"><h4 class=action-heading><div class=name>Retrieves the models available for the service</div><a href=#models-get class="method get">GET</a><code class=uri>/speech-to-text/api/v1/models</code></h4><p>Returns a list of all models available for use with the service. The information includes the name of the model, whether it pertains to broadband or narrowband audio, and its minimum sampling rate in Hertz, among other things.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/models</span></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Information about the available models."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"models"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>models</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"name"</span>,
<span class=hljs-string>"rate"</span>,
<span class=hljs-string>"url"</span>,
<span class=hljs-string>"language"</span>,
<span class=hljs-string>"description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>name</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Name of the model for use as an identifier in calls to the service (for example, `en-US_BroadbandModel`)."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>language</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Language identifier for the model (for example, `en-US`)."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>rate</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Sampling rate (minimum acceptable rate for audio) used by the model in Hertz."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for the model."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>sessions</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for the model for use with the POST `/v1/sessions` method."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Brief description of the model."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div><div id=models--1 class=resource><div id=models-get-1 class="action get"><h4 class=action-heading><div class=name>Retrieves information about the model</div><a href=#models-get-1 class="method get">GET</a><code class=uri>/speech-to-text/api/v1/models/{model_id}</code></h4><p>Returns information about a single specified model that is available for use with the service. The information includes the name of the model, whether it pertains to broadband or narrowband audio, and its minimum sampling rate in Hertz, among other things.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/models/<span class=hljs-attribute title=model_id>model_id</span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">model_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The identifier of the desired model in the form of its <code>name</code> from the output of GET <code>/v1/models</code>.</dl></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"name"</span>,
<span class=hljs-string>"rate"</span>,
<span class=hljs-string>"url"</span>,
<span class=hljs-string>"language"</span>,
<span class=hljs-string>"description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>name</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Name of the model for use as an identifier in calls to the service (for example, `en-US_BroadbandModel`)."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>language</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Language identifier for the model (for example, `en-US`)."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>rate</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Sampling rate (minimum acceptable rate for audio) used by the model in Hertz."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for the model."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>sessions</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for the model for use with the POST `/v1/sessions` method."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Brief description of the model."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. <code>Model not found</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div></section><section id=sessions class=resource-group><h2 class=group-heading>sessions <a href=#sessions class=permalink>¶</a></h2><div id=sessions-creates-a-session class=resource><div id=sessions-creates-a-session-post class="action post"><h4 class=action-heading><div class=name>Creates a session</div><a href=#sessions-creates-a-session-post class="method post">POST</a><code class=uri>/speech-to-text/api/v1/sessions</code></h4><p>Creates a session and locks recognition requests to that engine. You can use the session for multiple recognition requests so that each request is processed with the same Speech to Text engine. Use the cookie that is returned from this operation in the <code>set-cookie</code> header for each request that uses this session.<p>The session expires after 30 seconds of inactivity. Use a GET request on the <code>session_id</code> to prevent the session from expiring.<h4>Example URI</h4><div class=definition><span class="method post">POST</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/sessions</span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">model<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The identifier of the model to be used by the new session (use GET <code>/v1/models</code> or GET <code>/v1/models/{model_id}</code> for information about available models).</dl></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>201</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Created</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"session_id"</span>,
<span class=hljs-string>"new_session_uri"</span>,
<span class=hljs-string>"recognize"</span>,
<span class=hljs-string>"observe_result"</span>,
<span class=hljs-string>"recognizeWS"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>session_id</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Identifier for the new session."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>new_session_uri</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for the new session."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>recognize</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for REST recognition requests."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>observe_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for REST results observers."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>recognizeWS</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for WebSocket recognition requests. Needed only for working with the WebSocket interface."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div><div id=sessions- class=resource><div id=sessions-delete class="action delete"><h4 class=action-heading><div class=name>Deletes the specified session</div><a href=#sessions-delete class="method delete">DELETE</a><code class=uri>/speech-to-text/api/v1/sessions/{session_id}</code></h4><p>Deletes an existing session and its engine. You cannot send requests to a session after it is deleted.<h4>Example URI</h4><div class=definition><span class="method delete">DELETE</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/sessions/<span class=hljs-attribute title=session_id>session_id</span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">session_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the session to be deleted.</dl></div><div class=title><strong>Response <code>204</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>No Content</b>.</div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. <code>Cookie must be set</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. <code>'session_id' not found</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div><div id=sessions-get class="action get"><h4 class=action-heading><div class=name>Observes results for a recognition task within a session</div><a href=#sessions-get class="method get">GET</a><code class=uri>/speech-to-text/api/v1/sessions/{session_id}/observe_result</code></h4><p>Requests results for a recognition task within the specified session. You can submit multiple requests for the same recognition task. To see interim results, set the query parameter <code>interim_results=true</code>.<p>Specify a sequence ID (with the <code>sequence_id</code> query parameter) that matches the sequence ID of a recognition request to see results for that recognition task. A request with a sequence ID can arrive before, during, or after the matching recognition request, but it must arrive no later than 30 seconds after the recognition completes to avoid a session timeout (status code 408). Send multiple requests for the sequence ID with a maximum gap of 30 seconds to avoid the timeout. Omit the sequence ID to observe results for an ongoing recognition task; if no recognition is ongoing, the method returns results for the next recognition task regardless of whether it specifies a sequence ID.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/sessions/<span class=hljs-attribute title=session_id>session_id</span>/observe_result</span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">session_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the session whose results you want to observe.<dt style="padding:.2em 0">sequence_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The sequence ID of the recognition task whose results you want to observe. Omit the parameter to obtain results either for an ongoing recognition, if any, or for the next recognition task regardless of whether it specifies a sequence ID.<dt style="padding:.2em 0">interim_results<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code>, interim results are returned as a stream of JSON objects; each object represents a single <code>SpeechRecognitionEvent</code>. If <code>false</code>, the response is a single <code>SpeechRecognitionEvent</code> with final results only.</dl></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"results"</span>,
<span class=hljs-string>"result_index"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>results</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The results array consists of zero or more final results followed by zero or one interim result. The final results are guaranteed not to change; the interim result may be replaced by zero or more final results (followed by zero or one interim result). The service periodically sends updates to the result list, with the `result_index` set to the lowest index in the array that has changed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"final"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>final</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If `true`, the result for this utterance is not updated further."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of alternative transcripts."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"transcript"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>transcript</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Transcription of the audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the transcript in the range of 0 to 1. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>timestamps</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Time alignments for each word from transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in hundredths of seconds. Example: `[[\"hello\",0.0,1.2],[\"world\",1.2,2.5]]`. Available only for the best alternative."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: `[[\"hello\",0.95],[\"world\",0.866]]`. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>keywords_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"keyword"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>keyword</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"List of each keyword entered via the `keywords` parameter and, for each keyword, an array of `KeywordResult` objects that provides information about its occurrences in the input audio. The keys of the list are the actual keyword strings. A keyword for which no matches are spotted in the input is omitted from the array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"normalized_text"</span>,
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"confidence"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>normalized_text</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specified keyword normalized to the spoken phrase that matched in the audio input."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the keyword match in the range of 0 to 1."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses found for words of the input audio if `word_alternatives_threshold` is not null."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"confidence"</span>,
<span class=hljs-string>"word"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the word alternative hypothesis."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>word</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Word alternative hypothesis for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>result_index</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An index that indicates the change point in the `results` array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>warnings</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An array of warning messages about invalid query parameters or JSON fields included with the request. Each warning includes a descriptive message and a list of invalid argument strings. For example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query arguments:\"` followed by a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The request succeeds despite the warnings."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. User input error (for example, audio not matching the specified format) or an inactivity timeout occurred. If an existing session is closed, <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. <code>The 'session_id' was not found</code> or <code>A specified sequence_id does not match the sequence ID of the recognition task</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>408</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Request Timeout</b>. <code>Session closed due to inactivity</code> (session timeout) for 30 seconds. <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>413</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Payload Too Large</b>. <code>Session closed because the input stream is larger than currently supported data limit</code>. <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>500</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Internal server error</b>. The session is destroyed with <code>session_closed</code> set to <code>true</code>. Future requests that use this session return HTTP response code 404.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div><div id=sessions--1 class=resource><div id=sessions-get-1 class="action get"><h4 class=action-heading><div class=name>Checks whether a session is ready to accept a new recognition task</div><a href=#sessions-get-1 class="method get">GET</a><code class=uri>/speech-to-text/api/v1/sessions/{session_id}/recognize</code></h4><p>Provides a way to check whether the specified session can accept another recognition request. Concurrent recognition tasks during the same session are not allowed. The returned state must be <code>initialized</code> to indicate that you can send another recognition request with the POST <code>recognize</code> method.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/sessions/<span class=hljs-attribute title=session_id>session_id</span>/recognize</span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">session_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the session for the recognition task.</dl></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"session"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>session</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the state and possible actions for the current session."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"state"</span>,
<span class=hljs-string>"model"</span>,
<span class=hljs-string>"recognize"</span>,
<span class=hljs-string>"observe_result"</span>,
<span class=hljs-string>"recognizeWS"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>state</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"State of the session. The state must be `initialized` to perform a new recognition request on the session."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>model</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for information about the model that is used with the session."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>recognize</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for REST recognition requests."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>observe_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for REST results observers."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>recognizeWS</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"URI for WebSocket recognition requests. Needed only for working with the WebSocket interface."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. <code>'session_id' not found</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div><div id=sessions-post class="action post"><h4 class=action-heading><div class=name>Sends audio for speech recognition within a session</div><a href=#sessions-post class="method post">POST</a><code class=uri>/speech-to-text/api/v1/sessions/{session_id}/recognize{?sequence_id,continuous,keywords,keywords_threshold,max_alternatives,word_alternatives_threshold,word_confidence,timestamps,profanity_filter,smart_formatting}</code></h4><p>Sends audio and returns transcription results for a session-based recognition request. By default, returns only the final results; to see interim results, set the query parameter <code>interim_results=true</code> in a <code>GET</code> request to the <code>observe_result</code> method before this <code>POST</code> request finishes. To enable polling by the <code>observe_result</code> method for large audio requests, specify an integer with the <code>sequence_id</code> query parameter for non-multipart requests or with the <code>sequence_id</code> parameter of the JSON metadata for multipart requests. The service imposes a data size limit of 100 MB per session. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding.<h3 id=header-streaming-mode>Streaming mode <a class=permalink href=#header-streaming-mode aria-hidden=true>¶</a></h3><p>For requests to transcribe audio with more than one audio file (multipart requests) or to transcribe live audio as it becomes available, you must set <code>Transfer-Encoding</code> to <code>chunked</code> to use streaming mode. In streaming mode, the server closes the session (status code 408) if the service receives no data chunk for 30 seconds and the service has no audio to transcribe for 30 seconds. The server also closes the session (status code 400) if no speech is detected for <code>inactivity_timeout</code> seconds of audio (not processing time); use the <code>inactivity_timeout</code> parameter to change the default of 30 seconds.<h3 id=header-non-multipart-requests>Non-multipart requests <a class=permalink href=#header-non-multipart-requests aria-hidden=true>¶</a></h3><p>For non-multipart requests, you specify all parameters of the request as a path parameter, request headers, and query parameters. You provide the audio as the body of the request. Use the following parameters:<ul><li><p><b>Required:</b> <code>session_id</code>, <code>Content-Type</code>, and <code>body</code><li><p><b>Optional:</b> <code>Transfer-Encoding</code>, <code>sequence_id</code>, <code>continuous</code>, <code>inactivity_timeout</code>, <code>keywords</code>, <code>keywords_threshold</code>, <code>max_alternatives</code>, <code>word_alternatives_threshold</code>, <code>word_confidence</code>, <code>timestamps</code>, <code>profanity_filter</code>, and <code>smart_formatting</code></ul><h3 id=header-multipart-requests>Multipart requests <a class=permalink href=#header-multipart-requests aria-hidden=true>¶</a></h3><p>For multipart requests, you specify a few parameters of the request via a path parameter and as request headers, but you specify most parameters as multipart form data in the form of JSON metadata, in which only <code>part_content_type</code> is required. You then specify the audio files for the request as subsequent parts of the form data. Use the following parameters:<ul><li><p><b>Required:</b> <code>session_id</code>, <code>Content-Type</code>, <code>metadata</code>, and <code>multipart</code><li><p><b>Optional:</b> <code>Transfer-Encoding</code></ul><p>An example of the multipart metadata for the first part of a series of FLAC files follows. This first part of the request is sent as JSON. The remaining parts are one or more audio files (the example sends only a single audio file).<pre><code>metadata="{“part_content_type”:“audio/flac”,“data_parts_count”:1,“continuous”:true,“inactivity_timeout”:-1}"</code></pre><h4>Example URI</h4><div class=definition><span class="method post">POST</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/sessions/<span class=hljs-attribute title=session_id>session_id</span>/recognize?<span class=hljs-attribute>sequence_id=</span><span class=hljs-literal></span>&<span class=hljs-attribute>continuous=</span><span class=hljs-literal></span>&<span class=hljs-attribute>keywords=</span><span class=hljs-literal></span>&<span class=hljs-attribute>keywords_threshold=</span><span class=hljs-literal></span>&<span class=hljs-attribute>max_alternatives=</span><span class=hljs-literal></span>&<span class=hljs-attribute>word_alternatives_threshold=</span><span class=hljs-literal></span>&<span class=hljs-attribute>word_confidence=</span><span class=hljs-literal></span>&<span class=hljs-attribute>timestamps=</span><span class=hljs-literal></span>&<span class=hljs-attribute>profanity_filter=</span><span class=hljs-literal></span>&<span class=hljs-attribute>smart_formatting=</span><span class=hljs-literal></span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">session_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the session for the recognition task.<dt style="padding:.2em 0">sequence_id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Sequence ID of this recognition task in the form of a user-specified integer. If omitted, no sequence ID is associated with the recognition task.<dt style="padding:.2em 0">continuous<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, multiple final results representing consecutive phrases separated by long pauses are returned. Otherwise, recognition ends after the first “end of speech” incident is detected.<dt style="padding:.2em 0">inactivity_timeout - <u>Non-multipart only:</u> The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is closed with a 400 error and with `session_closed` set to `true`. Useful for stopping audio submission from a live microphone when a user simply walks away. Use `<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>1<code>for infinity. See also the</code>continuous` parameter.<dt style="padding:.2em 0">keywords<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are spotted only in the final hypothesis, not in interim results. Omit the parameter or specify an empty array if you do not need to spot keywords.<dt style="padding:.2em 0">keywords_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is performed if the default value (null) is used. If you specify a threshold, you must also specify one or more keywords.<dt style="padding:.2em 0">max_alternatives<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Maximum number of alternative transcripts to be returned. By default, a single transcription is returned.<dt style="padding:.2em 0">word_alternatives_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known as “Confusion Networks”). An alternative word is considered if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if the default value (null) is used.<dt style="padding:.2em 0">word_confidence<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, confidence measure per word is returned.<dt style="padding:.2em 0">timestamps<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, time alignment for each word is returned.<dt style="padding:.2em 0">profanity_filter<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code> (the default), filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to <code>false</code> to return results with no censoring. Applies to US English transcription only.<dt style="padding:.2em 0">smart_formatting<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request. If <code>false</code> (the default), no formatting is performed. Applies to US English transcription only.</dl></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"results"</span>,
<span class=hljs-string>"result_index"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>results</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The results array consists of zero or more final results followed by zero or one interim result. The final results are guaranteed not to change; the interim result may be replaced by zero or more final results (followed by zero or one interim result). The service periodically sends updates to the result list, with the `result_index` set to the lowest index in the array that has changed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"final"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>final</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If `true`, the result for this utterance is not updated further."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of alternative transcripts."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"transcript"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>transcript</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Transcription of the audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the transcript in the range of 0 to 1. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>timestamps</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Time alignments for each word from transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in hundredths of seconds. Example: `[[\"hello\",0.0,1.2],[\"world\",1.2,2.5]]`. Available only for the best alternative."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: `[[\"hello\",0.95],[\"world\",0.866]]`. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>keywords_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"keyword"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>keyword</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"List of each keyword entered via the `keywords` parameter and, for each keyword, an array of `KeywordResult` objects that provides information about its occurrences in the input audio. The keys of the list are the actual keyword strings. A keyword for which no matches are spotted in the input is omitted from the array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"normalized_text"</span>,
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"confidence"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>normalized_text</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specified keyword normalized to the spoken phrase that matched in the audio input."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the keyword match in the range of 0 to 1."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses found for words of the input audio if `word_alternatives_threshold` is not null."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"confidence"</span>,
<span class=hljs-string>"word"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the word alternative hypothesis."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>word</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Word alternative hypothesis for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>result_index</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An index that indicates the change point in the `results` array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>warnings</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An array of warning messages about invalid query parameters or JSON fields included with the request. Each warning includes a descriptive message and a list of invalid argument strings. For example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query arguments:\"` followed by a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The request succeeds despite the warnings."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. User input error (for example, audio not matching the specified format), the session is in the wrong state, or an inactivity timeout occurred. If an existing session is closed, <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. <code>'session_id' not found</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>408</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Request Timeout</b>. <code>Session closed due to inactivity</code> (session timeout) for 30 seconds. <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>413</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Payload Too Large</b>. <code>Session closed because the input stream is larger than 100 MB</code>. <code>session_closed</code> is set to <code>true</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>500</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Internal Server Error</b>. The session is destroyed with <code>session_closed</code> set to <code>true</code>. Future requests that use this session return HTTP response code 404.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>,
<span class=hljs-string>"session_closed"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>session_closed</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specifies the value `true` if the active session is closed as a result of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. <code>Session is already processing a request</code>. Concurrent requests are not allowed on the same session. Session remains alive after this error.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div></section><section id=sessionless class=resource-group><h2 class=group-heading>sessionless <a href=#sessionless class=permalink>¶</a></h2><div id=sessionless-sends-audio-for-speech-recognition-in-sessionless-mode class=resource><div id=sessionless-sends-audio-for-speech-recognition-in-sessionless-mode-post class="action post"><h4 class=action-heading><div class=name>Sends audio for speech recognition in sessionless mode</div><a href=#sessionless-sends-audio-for-speech-recognition-in-sessionless-mode-post class="method post">POST</a><code class=uri>/speech-to-text/api/v1/recognize</code></h4><p>Sends audio and returns transcription results for a sessionless recognition request. Returns only the final results; to enable interim results, use session-based requests or the WebSocket API. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding.<h3 id=header-streaming-mode-1>Streaming mode <a class=permalink href=#header-streaming-mode-1 aria-hidden=true>¶</a></h3><p>For requests to transcribe audio with more than one audio file (multipart requests) or to transcribe live audio as it becomes available, you must set the <code>Transfer-Encoding</code> header to <code>chunked</code> to use streaming mode. In streaming mode, the server closes the connection (status code 408) if the service receives no data chunk for 30 seconds and the service has no audio to transcribe for 30 seconds. The server also closes the connection (status code 400) if no speech is detected for <code>inactivity_timeout</code> seconds of audio (not processing time); use the <code>inactivity_timeout</code> parameter to change the default of 30 seconds.<h3 id=header-non-multipart-requests-1>Non-multipart requests <a class=permalink href=#header-non-multipart-requests-1 aria-hidden=true>¶</a></h3><p>For non-multipart requests, you specify all parameters of the request as a collection of request headers and query parameters, and you provide the audio as the body of the request. Use the following parameters:<ul><li><p><b>Required:</b> <code>Content-Type</code> and <code>body</code><li><p><b>Optional:</b> <code>Transfer-Encoding</code>, <code>model</code>, <code>continuous</code>, <code>inactivity_timeout</code>, <code>keywords</code>, <code>keywords_threshold</code>, <code>max_alternatives</code>, <code>word_alternatives_threshold</code>, <code>word_confidence</code>, <code>timestamps</code>, <code>profanity_filter</code>, and <code>smart_formatting</code></ul><h3 id=header-multipart-requests-1>Multipart requests <a class=permalink href=#header-multipart-requests-1 aria-hidden=true>¶</a></h3><p>For multipart requests, you specify a few parameters of the request as request headers and a query parameter, but you specify most parameters as multipart form data in the form of JSON metadata, in which only <code>part_content_type</code> is required. You then specify the audio files for the request as subsequent parts of the form data. Use the following parameters:<ul><li><p><b>Required:</b> <code>Content-Type</code>, <code>metadata</code>, and <code>multipart</code><li><p><b>Optional:</b> <code>Transfer-Encoding</code> and <code>model</code></ul><p>An example of the multipart metadata for the first part of a series of FLAC files follows. This first part of the request is sent as JSON. The remaining parts are one or more audio files (the example sends only a single audio file).<pre><code>metadata="{“part_content_type”:“audio/flac”,“data_parts_count”:1,“continuous”:true,“inactivity_timeout”=-1}"</code></pre><h4>Example URI</h4><div class=definition><span class="method post">POST</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/recognize</span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">model<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The identifier of the model to be used for the recognition request (use GET <code>/v1/models</code> for a list of available models).<dt style="padding:.2em 0">continuous<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, multiple final results that represent consecutive phrases separated by pauses are returned. Otherwise, recognition ends after the first “end of speech” incident is detected.<dt style="padding:.2em 0">inactivity_timeout<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. Use <code>-1</code> for infinity. See also the <code>continuous</code> parameter.<dt style="padding:.2em 0">keywords<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are spotted only in the final hypothesis, not in interim results. Omit the parameter or specify an empty array if you do not need to spot keywords.<dt style="padding:.2em 0">keywords_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is performed if the default value (null) is used. If you specify a threshold, you must also specify one or more keywords.<dt style="padding:.2em 0">max_alternatives<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Maximum number of alternative transcripts to be returned. By default, a single transcription is returned.<dt style="padding:.2em 0">word_alternatives_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> Confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known as “Confusion Networks”). An alternative word is considered if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if the default value (null) is used.<dt style="padding:.2em 0">word_confidence<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, confidence measure per word is returned.<dt style="padding:.2em 0">timestamps<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, time alignment for each word is returned.<dt style="padding:.2em 0">profanity_filter<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code> (the default), filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to <code>false</code> to return results with no censoring. Applies to US English transcription only.<dt style="padding:.2em 0">smart_formatting<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p><u>Non-multipart only:</u> If <code>true</code>, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request. If <code>false</code> (the default), no formatting is performed. Applies to US English transcription only.</dl></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"results"</span>,
<span class=hljs-string>"result_index"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>results</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The results array consists of zero or more final results followed by zero or one interim result. The final results are guaranteed not to change; the interim result may be replaced by zero or more final results (followed by zero or one interim result). The service periodically sends updates to the result list, with the `result_index` set to the lowest index in the array that has changed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"final"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>final</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If `true`, the result for this utterance is not updated further."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of alternative transcripts."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"transcript"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>transcript</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Transcription of the audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the transcript in the range of 0 to 1. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>timestamps</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Time alignments for each word from transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in hundredths of seconds. Example: `[[\"hello\",0.0,1.2],[\"world\",1.2,2.5]]`. Available only for the best alternative."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: `[[\"hello\",0.95],[\"world\",0.866]]`. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>keywords_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"keyword"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>keyword</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"List of each keyword entered via the `keywords` parameter and, for each keyword, an array of `KeywordResult` objects that provides information about its occurrences in the input audio. The keys of the list are the actual keyword strings. A keyword for which no matches are spotted in the input is omitted from the array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"normalized_text"</span>,
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"confidence"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>normalized_text</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specified keyword normalized to the spoken phrase that matched in the audio input."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the keyword match in the range of 0 to 1."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses found for words of the input audio if `word_alternatives_threshold` is not null."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"confidence"</span>,
<span class=hljs-string>"word"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the word alternative hypothesis."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>word</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Word alternative hypothesis for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>result_index</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An index that indicates the change point in the `results` array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>warnings</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An array of warning messages about invalid query parameters or JSON fields included with the request. Each warning includes a descriptive message and a list of invalid argument strings. For example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query arguments:\"` followed by a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The request succeeds despite the warnings."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. <code>User input error</code> (for example, audio not matching the specified format) or <code>Inactivity timeout</code> (no speech detected).</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>406</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Acceptable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>408</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Request Timeout</b>. <code>Request failed due to inactivity</code> (no audio data sent) for 30 seconds.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>413</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Payload Too Large</b>. <code>Request failed because the input stream is larger than 100 MB</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>415</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Unsupported Media Type</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>500</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Internal Server Error</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Body</h5><pre><code>{
"<span class=hljs-attribute>metadata</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span></span>,
"<span class=hljs-attribute>upload</span>": <span class=hljs-value><span class=hljs-string>"Hello, world!"</span>
</span>}</code></pre><div style=height:1px></div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div></section><section id=asynchronous class=resource-group><h2 class=group-heading>asynchronous <a href=#asynchronous class=permalink>¶</a></h2><div id=asynchronous-registers-a-callback-url-for-use-with-the-asynchronous-interface class=resource><div id=asynchronous-registers-a-callback-url-for-use-with-the-asynchronous-interface-post class="action post"><h4 class=action-heading><div class=name>Registers a callback URL for use with the asynchronous interface</div><a href=#asynchronous-registers-a-callback-url-for-use-with-the-asynchronous-interface-post class="method post">POST</a><code class=uri>/speech-to-text/api/v1/register_callback</code></h4><p>Registers a callback URL with the service for use with subsequent asynchronous recognition requests. The service attempts to register, or white-list, the callback URL. To be registered successfully, the callback URL must respond to a <code>GET</code> request from the service, after which the service responds with response code 201 to the original registration request.<p>The service sends only a single <code>GET</code> request to the callback URL. If the service does not receive a response with a response code of 200 and a body that echoes a random alphanumeric challenge string from the service within 5 seconds, it does not white-list the URL; it sends response code 400 in response to the registration request. If the requested callback URL is already white-listed, the service responds to the registration request with response code 200.<p>Once you successfully register a callback URL, you can use it with an indefinite number of recognition requests. You can register a maximum of 20 callback URLS in a one-hour span of time.<p>If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 signature of a random challenge string in its response to the request. It sends the signature in the <code>X-Callback-Signature</code> header of its <code>GET</code> request to the URL during registration. It also uses the secret to calculate a signature over the payload of every callback notification that uses the URL. The signature provides authentication and data integrity for HTTP communications.<p><b>Note:</b> This method is currently a beta release that supports US English only.<h4>Example URI</h4><div class=definition><span class="method post">POST</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/register_callback</span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">callback_url<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must successfully echo the challenge string during URL verification. During verification, the client can also check the signature that the service sends in the <code>X-Callback-Signature</code> header to verify the origin of the request.<dt style="padding:.2em 0">user_secret<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the <code>X-Callback-Signature</code> header. The service includes the header during URL verification and with every notification sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the parameter, the service does not send the header.</dl></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>. The callback was already registered (white-listed). The status included in the response is <code>already created</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"status"</span>,
<span class=hljs-string>"url"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>status</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The current status of the job: `created` if the callback URL was successfully white-listed as a result of the call or `already created` if the URL was already white-listed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The callback URL that is successfully registered."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>201</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Created</b>. The callback was successfully registered (white-listed). The status included in the response is <code>created</code>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"status"</span>,
<span class=hljs-string>"url"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>status</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The current status of the job: `created` if the callback URL was successfully white-listed as a result of the call or `already created` if the URL was already white-listed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The callback URL that is successfully registered."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. The callback registration failed. The request was missing a required parameter or specified an invalid argument; the client sent an invalid response to the service’s <code>GET</code> request during the registration process; or the client failed to respond to the server’s request before the five-second timeout.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. The service is currently unavailable.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div><div id=asynchronous- class=resource><div id=asynchronous-get class="action get"><h4 class=action-heading><div class=name>Checks the status of all asynchronous jobs</div><a href=#asynchronous-get class="method get">GET</a><code class=uri>/speech-to-text/api/v1/recognitions</code></h4><p>Returns the status and ID of all outstanding jobs associated with the service credentials with which it is called. If a job was created with a callback URL and a user token, the method also returns the user token for the job. To obtain the results for a job whose status is <code>completed</code>, use the <code>GET recognitions/{id}</code> method. A job and its results remain available until you delete them with the <code>DELETE recognitions/{id}</code> method or until the job’s time to live expires, whichever comes first.<p><b>Note:</b> This method is currently a beta release that supports US English only.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/recognitions</span></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"recognitions"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>recognitions</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An array of objects that provides the status for each of the user's current jobs. The array is empty if the user has no current jobs."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"id"</span>,
<span class=hljs-string>"status"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>id</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The ID of the job."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>status</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The current status of the job: `waiting`: The service is preparing the job for processing; the service always returns this status when the job is initially created. `processing`: The service is actively processing the job. `completed`: The service has finished processing the job; if the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, use the `GET recognitions/{id}` method to retrieve the results. `failed`: The job failed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"For a `POST /v1/recognitions` request, the URL to use to request information about the job with the `GET recognitions/{id}` method."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>user_token</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"For a `GET /v1/recognitions` request, the user token associated with the job if the job was created with a callback URL and a user token."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. The service is currently unavailable.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div><div id=asynchronous-post class="action post"><h4 class=action-heading><div class=name>Creates a job for an asynchronous recognition request</div><a href=#asynchronous-post class="method post">POST</a><code class=uri>/speech-to-text/api/v1/recognitions{?events,user_token,results_ttl,model,continuous,inactivity_timeout,keywords,keywords_threshold,max_alternatives,word_alternatives_threshold,word_confidence,timestamps,profanity_filter,smart_formatting}</code></h4><p>Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials are used to create it. How you learn the status and results of a job depends on the parameters you include with the job creation request:<ul><li><p>By callback notification: Include the <code>callback_url</code> query parameter to specify a URL to which the service is to send callback notifications when the status of the job changes. Optionally, you can also include the <code>events</code> and <code>user_token</code> query parameters to subscribe to specific events and to specify a string that is to be included with each notification for the job.<li><p>By polling the service: Omit the <code>callback_url</code>, <code>events</code>, and <code>user_token</code> query parameters. You must then use the <code>GET recognitions</code> or <code>GET recognitions/{id}</code> methods to check the status of the job, using the latter to retrieve the results when the job is complete.</ul><p>The two approaches are not mutually exclusive. You can poll the service for job status or obtain results from the service manually even if you include a callback URL. In both cases, you can include the <code>results_ttl</code> parameter to specify how long the results are to remain available after the job is complete. Note that using the HTTPS <code>GET recognitions/{id}</code> method to retrieve results is more secure than receiving them via callback notification over HTTP because it provides confidentiality in addition to authentication and data integrity.<p>The method supports the same basic parameters as all HTTP REST and WebSocket recognition requests; it does not support interim results or multipart data. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding.<p><b>Note:</b> This method is currently a beta release that supports US English only.<h4>Example URI</h4><div class=definition><span class="method post">POST</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/recognitions?<span class=hljs-attribute>events=</span><span class=hljs-literal></span>&<span class=hljs-attribute>user_token=</span><span class=hljs-literal></span>&<span class=hljs-attribute>results_ttl=</span><span class=hljs-literal></span>&<span class=hljs-attribute>model=</span><span class=hljs-literal></span>&<span class=hljs-attribute>continuous=</span><span class=hljs-literal></span>&<span class=hljs-attribute>inactivity_timeout=</span><span class=hljs-literal></span>&<span class=hljs-attribute>keywords=</span><span class=hljs-literal></span>&<span class=hljs-attribute>keywords_threshold=</span><span class=hljs-literal></span>&<span class=hljs-attribute>max_alternatives=</span><span class=hljs-literal></span>&<span class=hljs-attribute>word_alternatives_threshold=</span><span class=hljs-literal></span>&<span class=hljs-attribute>word_confidence=</span><span class=hljs-literal></span>&<span class=hljs-attribute>timestamps=</span><span class=hljs-literal></span>&<span class=hljs-attribute>profanity_filter=</span><span class=hljs-literal></span>&<span class=hljs-attribute>smart_formatting=</span><span class=hljs-literal></span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">callback_url - A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using the `POST register_callback` method. Omit the parameter to poll the service for job completion and results. You can include the same callback URL with any number of job creation requests. Use the `user_token` query parameter to specify a unique user<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>specified string with each job to differentiate the callback notifications for the jobs.<dt style="padding:.2em 0">events<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid events are: <code>recognitions.started</code> generates a callback notification when the service begins to process the job. <code>recognitions.completed</code> generates a callback notification when the job is complete; you must use the <code>GET recognitions/{id}</code> method to retrieve the results before they time out or are deleted. <code>recognitions.completed_with_results</code> generates a callback notification when the job is complete; the notification includes the results of the request. <code>recognitions.failed</code> generates a callback notification if the service experiences an error while processing the job. Omit the parameter to subscribe to the default events: <code>recognitions.started</code>, <code>recognitions.completed</code>, and <code>recognitions.failed</code>. The <code>recognitions.completed</code> and <code>recognitions.completed_with_results</code> events are incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the parameter.<dt style="padding:.2em 0">user_token<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If the job includes a callback URL, a user-specified string that the service is to include with each callback notification for the job; the token allows the user to maintain an internal mapping between jobs and notification events. If the job does not include a callback URL, omit the parameter.<dt style="padding:.2em 0">results_ttl<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The number of minutes for which the results are to be available after the job has finished. If not delivered via a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The parameter is valid with or without a callback URL.<dt style="padding:.2em 0">model<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The identifier of the model to be used for the recognition request. Currently, only <code>en-US-BroadbandModel</code> (the default) is supported.<dt style="padding:.2em 0">continuous<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code>, multiple final results that represent consecutive phrases separated by pauses are returned. Otherwise, recognition ends after the first “end of speech” incident is detected.<dt style="padding:.2em 0">inactivity_timeout<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. Use <code>-1</code> for infinity. See also the <code>continuous</code> parameter.<dt style="padding:.2em 0">keywords<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>Array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are spotted only in the final hypothesis, not in interim results. Omit the parameter or specify an empty array if you do not need to spot keywords.<dt style="padding:.2em 0">keywords_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>Confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is performed if the default value (null) is used. If you specify a threshold, you must also specify one or more keywords.<dt style="padding:.2em 0">max_alternatives<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>Maximum number of alternative transcripts to be returned. By default, a single transcription is returned.<dt style="padding:.2em 0">word_alternatives_threshold<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>Confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known as “Confusion Networks”). An alternative word is considered if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if the default value (null) is used.<dt style="padding:.2em 0">word_confidence<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code>, confidence measure per word is returned.<dt style="padding:.2em 0">timestamps<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code>, time alignment for each word is returned.<dt style="padding:.2em 0">profanity_filter<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code> (the default), filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to <code>false</code> to return results with no censoring. Applies to US English transcription only.<dt style="padding:.2em 0">smart_formatting<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>If <code>true</code>, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request. If <code>false</code> (the default), no formatting is performed. Applies to US English transcription only.</dl></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>201</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Created</b>. The job was successfully created.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"id"</span>,
<span class=hljs-string>"status"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>id</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The ID of the job."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>status</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The current status of the job: `waiting`: The service is preparing the job for processing; the service always returns this status when the job is initially created. `processing`: The service is actively processing the job. `completed`: The service has finished processing the job; if the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, use the `GET recognitions/{id}` method to retrieve the results. `failed`: The job failed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>url</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"For a `POST /v1/recognitions` request, the URL to use to request information about the job with the `GET recognitions/{id}` method."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>user_token</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"For a `GET /v1/recognitions` request, the user token associated with the job if the job was created with a callback URL and a user token."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>400</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Bad Request</b>. The request specified an invalid argument. For example, the request specified a callback URL that has not been white-listed, the <code>events</code> or <code>user_token</code> parameter without also specifying a callback URL, or both the <code>recognitions.completed</code> and <code>recognitions.completed_with_results</code> events.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Request</strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"byte"</span>
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. The service is currently unavailable.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div><div id=asynchronous--1 class=resource><div id=asynchronous-delete class="action delete"><h4 class=action-heading><div class=name>Deletes the specified asynchronous job</div><a href=#asynchronous-delete class="method delete">DELETE</a><code class=uri>/speech-to-text/api/v1/recognitions/{id}</code></h4><p>Deletes the specified job regardless of its current state. If you delete an active job, the service cancels the job without producing results. Once you delete a job, its results are no longer available. The service automatically deletes a job and its results when the time to live for the results expires. You must submit the request with the service credentials of the user who created the job.<p><b>Note:</b> This method is currently a beta release that supports US English only.<h4>Example URI</h4><div class=definition><span class="method delete">DELETE</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/recognitions/<span class=hljs-attribute title=id>id</span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the job that is to be deleted.</dl></div><div class=title><strong>Response <code>204</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>No Content</b>. The job was successfully deleted.</div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. The specified job ID was not found.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. The service is currently unavailable.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div><div id=asynchronous-get-1 class="action get"><h4 class=action-heading><div class=name>Checks the status of the specified asynchronous job</div><a href=#asynchronous-get-1 class="method get">GET</a><code class=uri>/speech-to-text/api/v1/recognitions/{id}</code></h4><p>Returns information about the specified job. The response always includes the status of the job. If the status is <code>completed</code>, the response includes the results of the recognition request; otherwise, the response includes the job ID. You must submit the request with the service credentials of the user who created the job.<p>You can use the method to retrieve the results of any job, regardless of whether it was submitted with a callback URL and the <code>recognitions.completed_with_results</code> event, and you can retrieve the results multiple times for as long as they remain available.<p><b>Note:</b> This method is currently a beta release that supports US English only.<h4>Example URI</h4><div class=definition><span class="method get">GET</span> <span class=uri><span class=hostname></span>/speech-to-text/api/v1/recognitions/<span class=hljs-attribute title=id>id</span></span></div><div class=title><strong>URI Parameters</strong></div><div><dl class=inner><dt style="padding:.2em 0">id<dd style="padding:.2em 0"><code>string</code> <span class=required>(required)</span> <p>The ID of the job whose status is to be checked.</dl></div><div class=title><strong>Response <code>200</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>OK</b>.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"status"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>status</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The current status of the job: `waiting`: The service is preparing the job for processing; the service also returns this status when the job is initially created. `processing`: The service is actively processing the job. `completed`: The service has finished processing the job; if the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, use the `GET recognitions/{id}` method to retrieve the results. `failed`: The job failed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>id</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If the status is not `completed`, the ID of the job."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>results</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If the status is `completed`, the results of the recognition request as an array that includes a single instance of a `SpeechRecognitionEvent` object."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"results"</span>,
<span class=hljs-string>"result_index"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>results</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"The results array consists of zero or more final results followed by zero or one interim result. The final results are guaranteed not to change; the interim result may be replaced by zero or more final results (followed by zero or one interim result). The service periodically sends updates to the result list, with the `result_index` set to the lowest index in the array that has changed."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"final"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>final</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"If `true`, the result for this utterance is not updated further."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"boolean"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of alternative transcripts."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"transcript"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>transcript</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Transcription of the audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the transcript in the range of 0 to 1. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>timestamps</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Time alignments for each word from transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in hundredths of seconds. Example: `[[\"hello\",0.0,1.2],[\"world\",1.2,2.5]]`. Available only for the best alternative."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: `[[\"hello\",0.95],[\"world\",0.866]]`. Available only for the best alternative and only in results marked as final."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>keywords_result</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array."</span></span>,
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"keyword"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>keyword</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"List of each keyword entered via the `keywords` parameter and, for each keyword, an array of `KeywordResult` objects that provides information about its occurrences in the input audio. The keys of the list are the actual keyword strings. A keyword for which no matches are spotted in the input is omitted from the array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"normalized_text"</span>,
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"confidence"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>normalized_text</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Specified keyword normalized to the spoken phrase that matched in the audio input."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the keyword match."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the keyword match in the range of 0 to 1."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>word_alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses found for words of the input audio if `word_alternatives_threshold` is not null."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"start_time"</span>,
<span class=hljs-string>"end_time"</span>,
<span class=hljs-string>"alternatives"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>start_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Start time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>end_time</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"End time in hundredths of seconds of the word from the input audio that corresponds to the word alternatives."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span>
</span>}</span>,
"<span class=hljs-attribute>alternatives</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Array of word alternative hypotheses for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"confidence"</span>,
<span class=hljs-string>"word"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>confidence</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Confidence score of the word alternative hypothesis."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"number"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"double"</span></span>,
"<span class=hljs-attribute>minimum</span>": <span class=hljs-value><span class=hljs-number>0</span></span>,
"<span class=hljs-attribute>maximum</span>": <span class=hljs-value><span class=hljs-number>1</span>
</span>}</span>,
"<span class=hljs-attribute>word</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Word alternative hypothesis for a word from the input audio."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</span>,
"<span class=hljs-attribute>result_index</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An index that indicates the change point in the `results` array."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>warnings</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"An array of warning messages about invalid query parameters or JSON fields included with the request. Each warning includes a descriptive message and a list of invalid argument strings. For example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query arguments:\"` followed by a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The request succeeds despite the warnings."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"array"</span></span>,
"<span class=hljs-attribute>items</span>": <span class=hljs-value>{
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>404</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Not Found</b>. The specified job ID was not found.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div><div class=title><strong>Response <code>503</code></strong><div class=collapse-button><span class=close>Hide</span><span class=open>Show</span></div></div><div class=collapse-content><div class=inner><div class=description><p><b>Service Unavailable</b>. The service is currently unavailable.</div><h5>Schema</h5><pre><code>{
"<span class=hljs-attribute>required</span>": <span class=hljs-value>[
<span class=hljs-string>"error"</span>,
<span class=hljs-string>"code"</span>,
<span class=hljs-string>"code_description"</span>
]</span>,
"<span class=hljs-attribute>properties</span>": <span class=hljs-value>{
"<span class=hljs-attribute>error</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Description of the problem."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}</span>,
"<span class=hljs-attribute>code</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"HTTP response code."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"integer"</span></span>,
"<span class=hljs-attribute>format</span>": <span class=hljs-value><span class=hljs-string>"int32"</span>
</span>}</span>,
"<span class=hljs-attribute>code_description</span>": <span class=hljs-value>{
"<span class=hljs-attribute>description</span>": <span class=hljs-value><span class=hljs-string>"Response message."</span></span>,
"<span class=hljs-attribute>type</span>": <span class=hljs-value><span class=hljs-string>"string"</span>
</span>}
</span>}
</span>}</code></pre><div style=height:1px></div></div></div></div></div></section></div></div></div><script>"use strict";function endsWith(e,t){return e.indexOf(t,e.length-t.length)!==-1}function childrenByClass(e,t){for(var n=[],o=0;o<e.children.length;o++){var l=e.children[o];l.className.split(" ").indexOf(t)!==-1&&n.push(l)}return n}function getWindowDimensions(){var e=window,t=document,n=t.documentElement,o=t.body;return[e.innerWidth||n.clientWidth||o.clientWidth,e.innerHeight||n.clientHeight||o.clientHeight]}function toggleCollapseButton(e){var t=e.target.parentNode,n=t.parentNode.nextSibling,o=n.children[0];t.className.indexOf("collapse-button")!==-1&&(n.style.maxHeight&&"0px"!==n.style.maxHeight?(t.className="collapse-button",n.style.maxHeight="0px"):(t.className="collapse-button show",n.style.maxHeight=o.offsetHeight+12+"px"))}function toggleTabButton(e){var t,n,o=e.target,l=childrenByClass(o.parentNode,"tab-button");for(t=0;t<l.length;t++)l[t]===o?(n=t,o.className="tab-button active"):l[t].className="tab-button";var a=childrenByClass(o.parentNode.parentNode,"tab");for(t=0;t<a.length;t++)a[t].style.display=t===n?"block":"none"}function toggleCollapseNav(e,t){var n=e.target.parentNode,o=n.nextSibling,l=o.children[0];n.className.indexOf("heading")!==-1&&(o.style.maxHeight&&"0px"!==o.style.maxHeight?(t||window.location.hash&&endsWith(e.target.href,window.location.hash))&&(o.style.maxHeight="0px"):o.style.maxHeight=l.offsetHeight+12+"px")}function refresh(e){document.querySelector("body").className="preload",document.body.innerHTML=e,init(),autoCollapse(),document.querySelector("body").className=""}function autoCollapse(){var e=getWindowDimensions()[1],t=64,n=Array.prototype.slice.call(document.querySelectorAll("nav .resource-group .heading"));n.forEach(function(e){t+=e.parentNode.offsetHeight});for(var o=n.sort(function(e,t){return e.parentNode.offsetHeight-t.parentNode.offsetHeight});o.length&&t>e;)for(var l=0;l<o.length;l++){var a=o[l].nextSibling.offsetHeight;if(t-a<=e||l===o.length-1){t-=a,toggleCollapseNav({target:o[l].children[0]},!0),o.splice(l,1);break}}}function init(){var e,t,n=document.querySelectorAll(".collapse-button");for(e=0;e<n.length;e++)n[e].onclick=toggleCollapseButton,n[e].className.indexOf("show")!==-1&&toggleCollapseButton({target:n[e].children[0]});var o=document.querySelectorAll(".example-names");for(e=0;e<o.length;e++){var l=childrenByClass(o[e],"tab-button");for(t=0;t<l.length;t++)l[t].onclick=toggleTabButton,0===t&&toggleTabButton({target:l[t]})}var a=document.querySelectorAll("nav .resource-group .heading");for(e=0;e<a.length;e++)a[e].onclick=toggleCollapseNav,toggleCollapseNav({target:a[e].children[0]})}init(),window.onload=function(){autoCollapse(),document.querySelector("body").className=""}</script><script src=/reload/reload.js></script>