-
Notifications
You must be signed in to change notification settings - Fork 4
/
openapi.yml
4089 lines (3890 loc) · 148 KB
/
openapi.yml
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
openapi: 3.1.0
info:
title: AssemblyAI API
description: AssemblyAI API
version: 1.0.0
contact:
name: API Support
email: support@assemblyai.com
url: https://www.assemblyai.com/docs/
servers:
- url: https://api.assemblyai.com
description: AssemblyAI API
tags:
- name: transcript
description: Transcript related operations
externalDocs:
url: https://www.assemblyai.com/docs/guides/transcribing-an-audio-file
- name: LeMUR
description: LeMUR related operations
externalDocs:
url: https://www.assemblyai.com/docs/guides/processing-audio-with-llms-using-lemur
- name: realtime
description: Real-time transcription
externalDocs:
url: https://www.assemblyai.com/docs/guides/real-time-streaming-transcription
security:
- ApiKey: []
paths:
/v2/upload:
post:
tags:
- transcript
summary: Upload a media file which can be transcribed
operationId: uploadFile
x-fern-sdk-group-name: files
x-fern-sdk-method-name: upload
description: Upload your media file directly to the AssemblyAI API if it isn't accessible via a URL already.
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
"200":
description: File uploaded successfully
content:
application/json:
schema:
$ref: "#/components/schemas/UploadedFile"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript:
post:
tags:
- transcript
summary: Create a transcript from an audio file
operationId: createTranscript
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: submit
x-fern-request-name: TranscriptParams
description: Create a transcript from an audio or video file that is accessible via a URL.
requestBody:
description: Params to create a transcript
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TranscriptParams"
responses:
"201":
description: Transcript created and queued for processing
content:
application/json:
schema:
$ref: "#/components/schemas/Transcript"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
get:
tags:
- transcript
summary: List transcripts
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: list
x-fern-request-name: ListTranscriptParams
operationId: listTranscripts
description: Retrieve a list of transcripts you created
parameters:
- name: limit
in: query
description: Maximum amount of transcripts to retrieve
schema:
$ref: "#/components/schemas/ListTranscriptParams/properties/limit"
- name: status
in: query
description: Filter by transcript status
schema:
# Use TranscriptStatus instead of
# ListTranscriptParams/properties/limit for better SDK generation
$ref: "#/components/schemas/TranscriptStatus"
- name: created_on
in: query
description: Only get transcripts created on this date
schema:
$ref: "#/components/schemas/ListTranscriptParams/properties/created_on"
- name: before_id
in: query
description: Get transcripts that were created before this transcript ID
schema:
$ref: "#/components/schemas/ListTranscriptParams/properties/before_id"
- name: after_id
in: query
description: Get transcripts that were created after this transcript ID
schema:
$ref: "#/components/schemas/ListTranscriptParams/properties/after_id"
- name: throttled_only
in: query
description: Only get throttled transcripts, overrides the status filter
schema:
$ref: "#/components/schemas/ListTranscriptParams/properties/throttled_only"
responses:
"200":
description: A list of transcripts
content:
application/json:
schema:
$ref: "#/components/schemas/TranscriptList"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}:
get:
tags:
- transcript
summary: Get the transcript
operationId: getTranscript
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: get
x-fern-request-name: GetTranscriptParams
description: Get the transcript resource. The transcript is ready when the "status" is "completed".
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
responses:
"200":
description: The transcript resource
content:
application/json:
schema:
$ref: "#/components/schemas/Transcript"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
delete:
tags:
- transcript
summary: Delete the transcript
operationId: deleteTranscript
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: delete
description: Delete the transcript
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
responses:
"200":
description: The deleted transcript response
content:
application/json:
schema:
$ref: "#/components/schemas/Transcript"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}/{subtitle_format}:
get:
tags:
- transcript
summary: Export transcript as SRT or VTT captions
operationId: getSubtitles
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: getSubtitles
x-fern-request-name: GetSubtitlesParams
description: Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
- name: subtitle_format
in: path
description: The format of the captions
required: true
schema:
$ref: "#/components/schemas/SubtitleFormat"
- name: chars_per_caption
in: query
description: The maximum number of characters per caption
schema:
type: integer
responses:
"200":
description: The exported captions as text
content:
text/plain:
schema:
type: string
example: |
WEBVTT
00:12.340 --> 00:16.220
Last year I showed these two slides said that demonstrate
00:16.200 --> 00:20.040
that the Arctic ice cap which for most of the last 3,000,000 years has been the
00:20.020 --> 00:25.040
size of the lower 48 States has shrunk by 40% but this understates
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}/sentences:
get:
tags:
- transcript
summary: Get the transcript split by sentences
operationId: getTranscriptSentences
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: getSentences
x-fern-request-name: GetSentencesParams
description: Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
responses:
"200":
description: Exported sentences
content:
application/json:
schema:
$ref: "#/components/schemas/SentencesResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}/paragraphs:
get:
tags:
- transcript
summary: Get the transcript split by paragraphs
operationId: getTranscriptParagraphs
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: getParagraphs
x-fern-request-name: GetParagraphsParams
description: Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
responses:
"200":
description: Exported paragraphs
content:
application/json:
schema:
$ref: "#/components/schemas/ParagraphsResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}/word-search:
get:
tags:
- transcript
summary: Search the given transcript for words, numbers, or phrases
operationId: wordSearch
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: wordSearch
x-fern-request-name: WordSearchParams
description: Search through the transcript for a specific set of keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers.
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
- name: words
in: query
description: Keywords to search for
required: true
schema:
type: array
items:
type: string
responses:
"200":
description: Word search response
content:
application/json:
schema:
$ref: "#/components/schemas/WordSearchResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/transcript/{transcript_id}/redacted-audio:
get:
tags:
- transcript
summary: Retrieve the redacted audio object containing the status and URL to the redacted audio.
description: Retrieve the redacted audio object containing the status and URL to the redacted audio.
operationId: getRedactedAudio
x-fern-sdk-group-name: transcripts
x-fern-sdk-method-name: getRedactedAudio
x-fern-request-name: GetRedactedAudioParams
parameters:
- name: transcript_id
in: path
description: ID of the transcript
required: true
schema:
type: string
responses:
"200":
description: The redacted audio object containing the status and URL to the redacted audio
content:
application/json:
schema:
$ref: "#/components/schemas/RedactedAudioResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/v2/realtime/token:
post:
tags:
- realtime
summary: Create a temporary authentication token for real-time transcription
description: Create a temporary authentication token for real-time transcription
operationId: createTemporaryToken
x-fern-sdk-group-name: realtime
x-fern-sdk-method-name: createTemporaryToken
x-fern-request-name: CreateRealtimeTemporaryTokenParams
requestBody:
description: Params to create a temporary authentication token
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateRealtimeTemporaryTokenParams"
responses:
"200":
description: Temporary authentication token generated
content:
application/json:
schema:
$ref: "#/components/schemas/RealtimeTemporaryTokenResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/lemur/v3/generate/task:
post:
tags:
- LeMUR
summary: Run a LLM task with your own prompt
operationId: lemurTask
x-fern-sdk-group-name: lemur
x-fern-sdk-method-name: task
x-fern-request-name: LemurTaskParams
description: Use the LeMUR task endpoint to input your own LLM prompt.
requestBody:
description: Params to run the task
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LemurTaskParams"
responses:
"200":
description: LeMUR task response
content:
application/json:
schema:
$ref: "#/components/schemas/LemurTaskResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/lemur/v3/generate/summary:
post:
tags:
- LeMUR
summary: Generate a custom summary from one or more transcripts
operationId: lemurSummary
x-fern-sdk-group-name: lemur
x-fern-sdk-method-name: summary
x-fern-request-name: LemurSummaryParams
description: Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.
requestBody:
description: Params to generate the summary
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LemurSummaryParams"
responses:
"200":
description: LeMUR summary response
content:
application/json:
schema:
$ref: "#/components/schemas/LemurSummaryResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/lemur/v3/generate/question-answer:
post:
tags:
- LeMUR
summary: Create answers to one or more questions about one or more transcripts
operationId: lemurQuestionAnswer
x-fern-sdk-group-name: lemur
x-fern-sdk-method-name: questionAnswer
x-fern-request-name: LemurQuestionAnswerParams
description: Question & Answer allows you to ask free-form questions about a single transcript or a group of transcripts. The questions can be any whose answers you find useful, such as judging whether a caller is likely to become a customer or whether all items on a meeting's agenda were covered.
requestBody:
description: Params to ask questions about the transcripts
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LemurQuestionAnswerParams"
responses:
"200":
description: LeMUR question & answer response
content:
application/json:
schema:
$ref: "#/components/schemas/LemurQuestionAnswerResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/lemur/v3/generate/action-items:
post:
tags:
- LeMUR
summary: Extract action items from one or more meeting transcripts
operationId: lemurActionItems
x-fern-sdk-group-name: lemur
x-fern-sdk-method-name: actionItems
x-fern-request-name: LemurActionItemsParams
description: Use LeMUR to generate a list of action items from a transcript
requestBody:
description: Params to generate action items from transcripts
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LemurActionItemsParams"
responses:
"200":
description: LeMUR action items response
content:
application/json:
schema:
$ref: "#/components/schemas/LemurActionItemsResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
/lemur/v3/{request_id}:
delete:
tags:
- LeMUR
summary: Delete the data for a previously submitted LeMUR request
operationId: purgeLemurRequestData
x-fern-sdk-group-name: lemur
x-fern-sdk-method-name: purgeRequestData
x-fern-request-name: PurgeLemurRequestDataParams
description: |
Delete the data for a previously submitted LeMUR request.
The LLM response data, as well as any context provided in the original request will be removed.
parameters:
- name: request_id
in: path
description: The ID of the LeMUR request whose data you want to delete. This would be found in the response of the original request.
required: true
schema:
type: string
responses:
"200":
description: LeMUR request data deleted
content:
application/json:
schema:
$ref: "#/components/schemas/PurgeLemurRequestDataResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"503":
$ref: "#/components/responses/ServiceUnavailable"
"504":
$ref: "#/components/responses/GatewayTimeout"
components:
schemas:
RedactedAudioResponse:
type: object
additionalProperties: false
x-fern-sdk-group-name: transcripts
required:
- status
- redacted_audio_url
properties:
status:
description: The status of the redacted audio
$ref: "#/components/schemas/RedactedAudioStatus"
redacted_audio_url:
description: The URL of the redacted audio file
type: string
example:
{
redacted_audio_url: "https://s3.us-west-2.amazonaws.com/api.assembly.ai.usw2/redacted-audio/785efd9e-0e20-45e1-967b-3db17770ed9f.wav?AWSAccessKeyId=ASIAVASQFLPGLUP5JD7Y&Signature=z1r2MOA46esiiAmk%2FreBkL8rl6g%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEPv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIHxKoUJdd5P%2Fdy4WlfvRNppQtauTy7OuAb5azR2OIoYSAiEA8iPx4xAx0pbZztT4e7fGnzPS4phvNCnYKflIijUoxDsq%2BwMIMxAEGgwzNDQ4MzkyNDg4NDQiDJxsCgo0cDg789FV0CrYAwPK3CHbRHoNPFiQ%2FO6EdHZ4OSFRcS%2FDvDyHQRNnYNSwG4JB2mUMWEVw808JWTya%2But4wEcmPiUCVJMTvh70cxhILAxP84CBTuWGM%2Fszbj4tn1thjVsqovf9YZmP17OCFa77Bc9%2F9RwtRaABEqJ2eb6%2Bsir7w0MMzhe1z%2F%2B1PUKxicJAZasBv3Ova%2BTY2eNkPZHQ4Njie4X5sh05b%2BrKnz58E7GTQ1sHZQDYHZecwb5fP0B3LR0vuqNtK%2BdpMAxw5H7BinQ4rdccLmsLLMQeVn8jdRDZNEvsdmoeQL0y0qD%2BUcyGMJoAjMT4FnXhBhVxc3bgkVUbHlZMn48FNCYcmzM8UB9wGmSnr6iQoqEaFElfQVbvAzsW7lnlfLROZxMvGXyliobPYPSaYZlVYgHcIxeWuOAXRtEtmL2jbaX4ghCVgJBVO3BBzTgub2jB0KPU6lYZLLM4kf%2B8hKX8iyxSRc6ZVEefTcyruoDppjB028pA9q75hLH1CZwhfLoM%2F3z5f0aFCl05zQnaa10nbcKj0hERELf4FXqS8yWbSutlRcd7Rr9o8jN31QGUscpsuIvl%2FpyJcZmItX8nO%2FF0s1QjrIi11DLYD9YoOh7eVkN8eKKn5w4cHldVI2sw4NCPqgY6pQE%2BM9va2ad1%2BNrXeQ9t8K41lojTN0BFmM8ERD5fF77xcTlW8VdV%2FiJeLLHDvnYYWVKcga9hSROlmsqvMyn3Tmhz7KQbIepSAOKhcHM%2FyUaLfErvCtjXGwo8nsKForL7SKiGkaRCBmwfQtkSVP6m4tGT50YdGxakh54f8uyC55SbkElknRbpl5haiZ%2F82UddFBkdPcM3t0s7vwbEy%2BbilYyetOr6htc%3D&Expires=1698966551",
status: "redacted_audio_ready",
}
RedactedAudioStatus:
description: The status of the redacted audio
x-fern-sdk-group-name: transcripts
type: string
enum:
- redacted_audio_ready
SubtitleFormat:
description: Format of the subtitles
x-fern-sdk-group-name: transcripts
type: string
enum:
- srt
- vtt
WordSearchResponse:
type: object
x-fern-sdk-group-name: transcripts
additionalProperties: false
properties:
id:
description: The ID of the transcript
type: string
format: uuid
total_count:
description: The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5.
type: integer
matches:
description: The matches of the search
type: array
items:
$ref: "#/components/schemas/WordSearchMatch"
required:
- id
- total_count
- matches
example:
{
id: "d5a3d302-066e-43fb-b63b-8f57baf185db",
total_count: 10,
matches:
[
{
text: "smoke",
count: 6,
timestamps:
[
[250, 650],
[49168, 49398],
[55284, 55594],
[168888, 169118],
[215108, 215386],
[225944, 226170],
],
indexes: [0, 136, 156, 486, 652, 698],
},
{
text: "wildfires",
count: 4,
timestamps:
[[1668, 2346], [33852, 34546], [50118, 51110], [231356, 232354]],
indexes: [4, 90, 140, 716],
},
],
}
WordSearchMatch:
type: object
x-fern-sdk-group-name: transcripts
additionalProperties: false
properties:
text:
description: The matched word
type: string
count:
description: The total amount of times the word is in the transcript
type: integer
timestamps:
description: An array of timestamps
type: array
items:
$ref: "#/components/schemas/WordSearchTimestamp"
indexes:
description: An array of all index locations for that word within the `words` array of the completed transcript
type: array
items:
type: integer
required:
- text
- count
- timestamps
- indexes
example:
{
text: "smoke",
count: 6,
timestamps:
[
[250, 650],
[49168, 49398],
[55284, 55594],
[168888, 169118],
[215108, 215386],
[225944, 226170],
],
indexes: [0, 136, 156, 486, 652, 698],
}
WordSearchTimestamp:
description: An array of timestamps structured as [`start_time`, `end_time`] in milliseconds
x-fern-sdk-group-name: transcripts
type: array
items:
type: integer
example:
[250, 650]
Timestamp:
description: Timestamp containing a start and end property in milliseconds
x-fern-sdk-group-name: transcripts
type: object
additionalProperties: false
properties:
start:
description: The start time in milliseconds
type: integer
end:
description: The end time in milliseconds
type: integer
required:
- start
- end
example:
{ start: 3978, end: 5114 }
# This type is used by the Transcriber
TranscriptOptionalParams:
description: The parameters for creating a transcript
x-fern-sdk-group-name: transcripts
type: object
additionalProperties: false
properties:
speech_model:
description: The speech model to use for the transcription. When `null`, the default model is used.
default: null
oneOf:
- $ref: "#/components/schemas/SpeechModel"
- type: "null"
language_code:
description: |
The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
The default value is 'en_us'.
oneOf:
- $ref: "#/components/schemas/TranscriptLanguageCode"
- type: "null"
punctuate:
description: Enable Automatic Punctuation, can be true or false
type: boolean
format_text:
description: Enable Text Formatting, can be true or false
type: boolean
dual_channel:
description: Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
type: boolean
webhook_url:
description: The URL to which AssemblyAI send webhooks upon trancription completion
type: string
webhook_auth_header_name:
description: The header name which should be sent back with webhook calls
type: [string, "null"]
default: null
webhook_auth_header_value:
description: Specify a header name and value to send back with a webhook call for added security
type: [string, "null"]
default: null
auto_highlights:
description: Whether Key Phrases is enabled, either true or false
type: boolean
audio_start_from:
description: The point in time, in milliseconds, to begin transcribing in your media file
type: integer
audio_end_at:
description: The point in time, in milliseconds, to stop transcribing in your media file
type: integer
word_boost:
description: The list of custom vocabulary to boost transcription probability for
type: array
items:
type: string
boost_param:
description: The word boost parameter value
$ref: "#/components/schemas/TranscriptBoostParam"
filter_profanity:
description: Filter profanity from the transcribed text, can be true or false
type: boolean
redact_pii:
description: Redact PII from the transcribed text using the Redact PII model, can be true or false
type: boolean
redact_pii_audio:
description: Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
type: boolean
redact_pii_audio_quality:
description: Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
default: mp3
$ref: "#/components/schemas/RedactPiiAudioQuality"
redact_pii_policies:
description: The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
type: array
items:
$ref: "#/components/schemas/PiiPolicy"
redact_pii_sub:
description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
oneOf:
- $ref: "#/components/schemas/SubstitutionPolicy"
- type: "null"
speaker_labels:
description: Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
type: boolean
speakers_expected:
description: Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
type: [integer, "null"]
default: null
content_safety:
description: Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
type: boolean
content_safety_confidence:
description: The confidence threshold for content moderation. Values must be between 25 and 100.
type: integer
iab_categories:
description: Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false
type: boolean
language_detection:
description: Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) was enabled in the transcription request, either true or false.
type: boolean
custom_spelling: