-
Notifications
You must be signed in to change notification settings - Fork 1
/
slate_wide.html
2068 lines (2068 loc) · 265 KB
/
slate_wide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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}.hljs-comment,.hljs-quote{color:#9e8f9e}.hljs-attribute,.hljs-link,.hljs-name,.hljs-regexp,.hljs-selector-class,.hljs-selector-id,.hljs-tag,.hljs-template-variable,.hljs-variable{color:#ca402b}.hljs-built_in,.hljs-literal,.hljs-meta,.hljs-number,.hljs-params,.hljs-type{color:#a65926}.hljs-bullet,.hljs-string,.hljs-symbol{color:#918b3b}.hljs-section,.hljs-title{color:#516aec}.hljs-keyword,.hljs-selector-tag{color:#7b59c0}.hljs{display:block;overflow-x:auto;background:#1b181b;color:#ab9bab;padding:.5em}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.right .hljs-comment,.right .hljs-quote{color:#776977}.right .hljs-attribute,.right .hljs-link,.right .hljs-name,.right .hljs-regexp,.right .hljs-selector-class,.right .hljs-selector-id,.right .hljs-tag,.right .hljs-template-variable,.right .hljs-variable{color:#ca402b}.right .hljs-built_in,.right .hljs-literal,.right .hljs-meta,.right .hljs-number,.right .hljs-params,.right .hljs-type{color:#a65926}.right .hljs-bullet,.right .hljs-string,.right .hljs-symbol{color:#918b3b}.right .hljs-section,.right .hljs-title{color:#516aec}.right .hljs-keyword,.right .hljs-selector-tag{color:#7b59c0}.right .hljs{display:block;overflow-x:auto;background:#f7f3f7;color:#695d69;padding:.5em}.right .hljs-emphasis{font-style:italic}.right .hljs-strong{font-weight:700}body{color:#c8c8c8;background:#272b30;font:400 14px/1.42 Roboto,Helvetica,sans-serif}header{border-bottom:1px solid #373d44;margin-bottom:12px}h1,h2,h3,h4,h5{color:#c8c8c8;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:#fff;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(200,200,200,0) 20%,rgba(200,200,200,.2) 51.4%,rgba(39,43,48,.2) 51.4%,rgba(39,43,48,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(200,200,200,.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #2b3237}blockquote p:last-child{margin-bottom:0}pre{background-color:#202529;padding:12px;border:1px solid #424c54;border-radius:6px;overflow:auto}pre code{color:#c8c8c8;background-color:transparent;padding:0;border:none}code{color:#ddd;background-color:#373b40;font:Inconsolata,monospace;padding:1px 4px;border:1px solid #424c54;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:#22262a}table td,table th{padding:6px 12px;border:1px solid #101214}.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:#c8c8c8;background-color:#2b373e;border-left:4px solid #5bc0de}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#5bc0de}.warning{color:#c8c8c8;background-color:#352b30;border-left:4px solid #e9322d}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#e9322d}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:#c8c8c8;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 #c8c8c8}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(200,200,200,.7);padding:8px 12px;border-top:1px solid #202020;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 #c8c8c8}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:#fff;background-color:#373d44;border-radius:10px;margin:-2px 0}.badge.get{color:#fff;background-color:#5bc0de}.badge.head{color:#fff;background-color:#5bc0de}.badge.options{color:#fff;background-color:#5bc0de}.badge.put{color:#fff;background-color:#f89406}.badge.patch{color:#fff;background-color:#f89406}.badge.post{color:#fff;background-color:#62c462}.badge.delete{color:#fff;background-color:#ee5f5b}.collapse-button{float:right}.collapse-button .close{display:none;color:#fff;cursor:pointer}.collapse-button .open{color:#fff;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:#666}.right div,.right h1,.right h2,.right h3,.right h4,.right h5,.right p{color:#272b30}.right pre{background-color:#f7f6f5;border:1px solid #f7f6f5}.right pre code{color:#333}.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:#2e98b8}.definition .method.head{color:#2e98b8}.definition .method.options{color:#2e98b8}.definition .method.post{color:#2eb82e}.definition .method.put{color:#b87f2e}.definition .method.patch{color:#b87f2e}.definition .method.delete{color:#b8322e}.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:#c8c8c8;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#adaaa6}.right .example-names .tab-button{color:#272b30;border:1px solid #d8d4cf;border-radius:6px}.right .example-names .tab-button.active{background-color:#95918b}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#272b30;border-right:1px solid #272b30;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#d8d4cf;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(200,200,200,.5);background-color:#373d44;text-decoration:none!important;border-top:1px solid #202020;border-left:1px solid #202020;border-right:1px solid #202020;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:#272b30;border:1px solid #202020;border-radius:6px}.resource-group .heading a,.resource-group h2.group-heading{padding:12px;margin:-12px -12px 12px -12px;background-color:#373d44;border-bottom:1px solid #202020;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 #202020}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:#000;background-color:#2390b0}.action h4.action-heading .method.head{color:#000;background-color:#2390b0}.action h4.action-heading .method.options{color:#000;background-color:#2390b0}.action h4.action-heading .method.put{color:#fff;background-color:#945904}.action h4.action-heading .method.patch{color:#fff;background-color:#945904}.action h4.action-heading .method.post{color:#000;background-color:#348c34}.action h4.action-heading .method.delete{color:#fff;background-color:#ce1a15}.action h4.action-heading code{color:#000;background-color:rgba(255,255,255,.7);border-color:transparent;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 #272b30;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#202020}.action.get h4.action-heading{color:#2390b0;background:#5bc0de;border-bottom-color:#202020}.action.head{border-color:#202020}.action.head h4.action-heading{color:#2390b0;background:#5bc0de;border-bottom-color:#202020}.action.options{border-color:#202020}.action.options h4.action-heading{color:#2390b0;background:#5bc0de;border-bottom-color:#202020}.action.post{border-color:#202020}.action.post h4.action-heading{color:#348c34;background:#62c462;border-bottom-color:#202020}.action.put{border-color:#202020}.action.put h4.action-heading{color:#945904;background:#f89406;border-bottom-color:#202020}.action.patch{border-color:#202020}.action.patch h4.action-heading{color:#945904;background:#f89406;border-bottom-color:#202020}.action.delete{border-color:#202020}.action.delete h4.action-heading{color:#ce1a15;background:#ee5f5b;border-bottom-color:#202020}</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-fluid><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>,