Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2240 lines (2240 loc) · 60.7 KB
/
Copy pathopenapi.yaml
File metadata and controls
2240 lines (2240 loc) · 60.7 KB
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
# Generated by scripts/extract.mjs from https://www.transcriptdock.com/docs/openapi.yaml.
# Public endpoints only. Do not edit by hand; run npm run extract.
openapi: 3.1.0
info:
title: Transcript Dock API
version: 1.0.0
description: |
Transcripts from YouTube, TikTok, Instagram and your own media through one API.
Submit a job, poll it or receive a webhook, then read or export the timed transcript.
Creating jobs can spend credits: set max_credits and send an Idempotency-Key with every submission.
termsOfService: https://www.transcriptdock.com/docs/terms
contact:
name: Transcript Dock
url: https://www.transcriptdock.com/docs
email: transcriptdock@volods.com
license:
name: MIT
identifier: MIT
externalDocs:
description: Documentation
url: https://www.transcriptdock.com/docs
servers:
- url: https://www.transcriptdock.com
description: Production
tags:
- name: jobs
description: Submit and track transcription work
- name: batches
description: Multi URL submissions with aggregate status
- name: transcripts
description: Read, export, and delete stored results
- name: uploads
description: Signed direct to Storage media intake
- name: account
description: Usage, keys, billing, profile (session or scoped key)
- name: webhooks
description: Customer event endpoint registration
security:
- bearer: []
paths:
/v1/capabilities:
get:
tags:
- jobs
summary: Supported platforms, modes, and limits
description: |
Without a credential this returns the public matrix, cached at the edge.
With a key, a Supabase access token or a session cookie it returns the
matrix for that workspace's plan with Cache-Control private, no-store.
A credential that is sent and rejected gets 401, never the public matrix.
security:
- {}
- bearer: []
operationId: getCapabilities
responses:
"200":
description: Machine readable capability matrix
content:
application/json:
schema:
$ref: "#/components/schemas/Capabilities"
example:
youtube:
enabled: true
captions_only: true
auto: false
transcribe: false
social_acquisition_fee: true
instagram:
enabled: true
captions_only: false
auto: false
transcribe: false
social_acquisition_fee: true
native_captions: unverified_disabled
upload:
enabled: false
captions_only: false
auto: false
transcribe: false
social_acquisition_fee: false
direct:
enabled: false
captions_only: false
auto: false
transcribe: false
social_acquisition_fee: false
max_duration_ms: 7200000
max_media_bytes: 262144000
export_formats:
- txt
- json
- srt
- vtt
recognition_profiles:
- standard
transcribe_credits_per_minute: 2
minimum_billable_seconds: 60
price_version: 2026-09-14
asr_enabled: false
instagram_enabled: true
free_caption_credits: 50
free_caption_credits_period: month
"401":
description: A credential was sent and rejected (unknown key, expired token)
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
"429":
description: Anonymous per IP budget or rejected credential budget exhausted; obey Retry-After
headers:
Retry-After:
schema:
type: integer
description: Seconds until the window resets.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
"500":
description: Session or credential lookup failed; retryable
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
/v1/jobs:
post:
tags:
- jobs
summary: Submit one source
operationId: createJob
parameters:
- $ref: "#/components/parameters/IdempotencyKey"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/JobRequest"
example:
source:
url: https://www.youtube.com/watch?v=dQw4w9WgXcQ
mode: captions_only
responses:
"200":
description: Reused a retained same workspace result for free
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"202":
description: Accepted; work queued. Location points at GET /v1/jobs/{id}; Retry-After suggests the first poll delay.
headers:
Location:
schema:
type: string
description: Path of the job to poll.
Retry-After:
schema:
type: integer
description: Seconds before the first poll.
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"402":
$ref: "#/components/responses/BillableError"
"409":
description: Idempotency key already used with a different body
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
"422":
$ref: "#/components/responses/ValidationError"
get:
tags:
- jobs
summary: Workspace job history (cursor pagination)
operationId: listJobs
parameters:
- name: cursor
in: query
schema:
type: string
description: Opaque cursor from a previous page
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- name: platform
in: query
schema:
$ref: "#/components/schemas/Platform"
description: With source_id, only jobs for that one video (any mode). Both or neither.
- name: source_id
in: query
schema:
type: string
maxLength: 128
description: The platform media id, as returned in job.source.media_id
responses:
"200":
description: Newest first, ordered by created_at and id
content:
application/json:
schema:
$ref: "#/components/schemas/JobList"
/v1/language-discoveries:
post:
tags:
- jobs
summary: Queue bounded YouTube timed text language discovery
operationId: createLanguageDiscovery
parameters:
- $ref: "#/components/parameters/IdempotencyKey"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LanguageDiscoveryRequest"
responses:
"200":
description: Same workspace discovery result reused from the short cache
content:
application/json:
schema:
$ref: "#/components/schemas/LanguageDiscovery"
"202":
description: Discovery queued or already processing
content:
application/json:
schema:
$ref: "#/components/schemas/LanguageDiscovery"
"422":
$ref: "#/components/responses/ValidationError"
/v1/language-discoveries/{id}:
get:
tags:
- jobs
summary: Read a workspace scoped language discovery
operationId: getLanguageDiscovery
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Discovery status and exact source language inventory
content:
application/json:
schema:
$ref: "#/components/schemas/LanguageDiscovery"
/v1/video-discoveries:
post:
tags:
- jobs
summary: Queue a video listing discovery
operationId: createVideoDiscovery
parameters:
- $ref: "#/components/parameters/IdempotencyKey"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/VideoDiscoveryRequest"
responses:
"200":
description: Same workspace discovery result reused from the short cache
content:
application/json:
schema:
$ref: "#/components/schemas/VideoDiscovery"
"202":
description: Discovery queued or already processing
content:
application/json:
schema:
$ref: "#/components/schemas/VideoDiscovery"
"422":
$ref: "#/components/responses/ValidationError"
/v1/video-discoveries/{id}:
get:
tags:
- jobs
summary: Read a workspace scoped video discovery
operationId: getVideoDiscovery
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Discovery status, video listing, and paging cursor
content:
application/json:
schema:
$ref: "#/components/schemas/VideoDiscovery"
/v1/jobs/{id}:
get:
tags:
- jobs
summary: Job status, stage, error, result reference, billing
operationId: getJob
parameters:
- $ref: "#/components/parameters/JobId"
- name: wait
in: query
required: false
schema:
type: integer
minimum: 0
maximum: 25
default: 0
description: Long poll. Hold the request up to this many seconds and return as soon as the job is succeeded, failed or cancelled. One rate-limited request replaces a client poll loop.
- name: seen_status
in: query
required: false
schema:
$ref: "#/components/schemas/JobStatus"
description: With wait, the status you already show. The long poll also returns as soon as the job's status or stage differs from seen_status and seen_stage, so a progress view can follow each stage. Omit it to wait for the end only.
- name: seen_stage
in: query
required: false
schema:
type: string
enum:
- ""
- resolve
- captions
- acquire_audio
- submit_asr
- wait_asr
- finalize
description: With seen_status, the stage you already show. Empty or absent means no stage yet.
responses:
"200":
description: Job record (terminal failures stay HTTP 200 with status failed)
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"404":
$ref: "#/components/responses/NotFound"
/v1/jobs/{id}/cancel:
post:
tags:
- jobs
summary: Cancel before AssemblyAI submission starts
operationId: cancelJob
parameters:
- $ref: "#/components/parameters/JobId"
responses:
"200":
description: Cancelled, or not allowed once submission started
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"409":
description: Cancellation window has passed
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
/v1/jobs/{id}/retry:
post:
tags:
- jobs
summary: New job from a retryable terminal failure
operationId: retryJob
parameters:
- $ref: "#/components/parameters/JobId"
- $ref: "#/components/parameters/IdempotencyKey"
requestBody:
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/JobRetryRequest"
responses:
"200":
description: Same retry idempotency key replayed
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"202":
description: Retry accepted as a new job
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
/v1/batches:
post:
tags:
- batches
summary: Submit 1 to plan limit jobs atomically
operationId: createBatch
parameters:
- $ref: "#/components/parameters/IdempotencyKey"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/BatchRequest"
responses:
"200":
description: Same batch idempotency key replayed
content:
application/json:
schema:
$ref: "#/components/schemas/Batch"
"202":
description: Batch accepted; children reserved together or whole batch rejected
content:
application/json:
schema:
$ref: "#/components/schemas/Batch"
"402":
$ref: "#/components/responses/BillableError"
"422":
$ref: "#/components/responses/ValidationError"
/v1/batches/{id}:
get:
tags:
- batches
summary: Batch counters and child job ids
operationId: getBatch
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Aggregate status derived from child counts
content:
application/json:
schema:
$ref: "#/components/schemas/Batch"
"404":
$ref: "#/components/responses/NotFound"
/v1/transcripts/{id}:
get:
tags:
- transcripts
summary: Normalized stored result
operationId: getTranscript
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Transcript with segment timing; words null when unavailable
content:
application/json:
schema:
$ref: "#/components/schemas/TranscriptResult"
"404":
$ref: "#/components/responses/NotFound"
delete:
tags:
- transcripts
summary: Hide immediately and schedule purge
operationId: deleteTranscript
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"202":
description: Deletion scheduled; cache entry invalidated
content:
application/json:
schema:
$ref: "#/components/schemas/TranscriptDeletion"
"404":
$ref: "#/components/responses/NotFound"
/v1/transcripts/{id}/export:
get:
tags:
- transcripts
summary: Export a stored result without paying again
operationId: exportTranscript
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: format
in: query
required: true
schema:
type: string
enum:
- txt
- json
- srt
- vtt
responses:
"200":
description: File body with a download filename
content:
text/plain:
schema:
type: string
application/json:
schema:
type: object
text/vtt:
schema:
type: string
text/srt:
schema:
type: string
"422":
description: No usable timing for a timed format
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
/v1/uploads:
post:
tags:
- uploads
summary: Reserve an upload slot and get a signed URL
operationId: createUpload
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UploadRequest"
responses:
"201":
description: Slot reserved; PUT the file to signed_upload_url, then complete
content:
application/json:
schema:
$ref: "#/components/schemas/Upload"
/v1/uploads/{id}/complete:
post:
tags:
- uploads
summary: Verify a finished upload and mark it ready
operationId: completeUpload
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Upload ready for use as a job source
content:
application/json:
schema:
$ref: "#/components/schemas/UploadCompletion"
/v1/usage:
get:
tags:
- account
summary: Caption allowance, wallet balance, and reservations
operationId: getUsage
responses:
"200":
description: Current plan, allowance, and wallet in USD strings
content:
application/json:
schema:
$ref: "#/components/schemas/Usage"
/v1/webhook-endpoints:
get:
tags:
- webhooks
summary: List workspace endpoints (secrets never returned)
operationId: listWebhookEndpoints
responses:
"200":
description: Enabled and disabled endpoints
content:
application/json:
schema:
$ref: "#/components/schemas/WebhookEndpointList"
post:
tags:
- webhooks
summary: Register an HTTPS endpoint (owner session in MVP)
operationId: createWebhookEndpoint
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WebhookEndpointRequest"
responses:
"201":
description: Endpoint with the signing secret shown exactly once
content:
application/json:
schema:
$ref: "#/components/schemas/WebhookEndpointWithSecret"
/v1/webhook-endpoints/{id}:
delete:
tags:
- webhooks
summary: Disable an endpoint
operationId: deleteWebhookEndpoint
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
"204":
description: Disabled
/health:
get:
tags:
- jobs
summary: Process liveness only (no extraction detail)
operationId: health
security: []
responses:
"200":
description: Healthy
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
enum:
- ok
components:
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: true
schema:
type: string
minLength: 8
maxLength: 128
pattern: ^[ -~]+$
description: Workspace plus endpoint scoped replay key, 8 to 128 ASCII chars
JobId:
name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
ValidationError:
description: Request shape or capability rejected
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
BillableError:
description: Reservation refused (balance, budget, plan)
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
NotFound:
description: Unknown id, or an id from another workspace
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
schemas:
ErrorCode:
type: string
enum:
- INVALID_REQUEST
- INVALID_URL
- INVALID_CURSOR
- UNSUPPORTED_SOURCE
- UNSUPPORTED_MEDIA
- CAPABILITY_UNAVAILABLE
- UNAUTHENTICATED
- FORBIDDEN
- EMAIL_UNVERIFIED
- NOT_FOUND
- INSUFFICIENT_BALANCE
- PLAN_REQUIRED
- BUDGET_EXCEEDED
- IDEMPOTENCY_CONFLICT
- JOB_NOT_RETRYABLE
- CANCELLATION_NOT_ALLOWED
- RATE_LIMITED
- SOURCE_NOT_FOUND
- SOURCE_PRIVATE
- SOURCE_AUTH_REQUIRED
- SOURCE_REGION_RESTRICTED
- NO_CAPTIONS
- LANGUAGE_UNAVAILABLE
- LANGUAGE_UNSUPPORTED
- NO_SPEECH
- NO_AUDIO
- TIMESTAMPS_UNAVAILABLE
- DURATION_LIMIT_EXCEEDED
- FILE_TOO_LARGE
- UNSAFE_URL
- INVALID_MEDIA
- SOURCE_RATE_LIMITED
- SOURCE_BLOCKED
- SOURCE_TIMEOUT
- SOURCE_CHANGED
- PROVIDER_UNAVAILABLE
- STORAGE_UNAVAILABLE
- PROVIDER_REJECTED
- INTERNAL_ERROR
ErrorObject:
type: object
required:
- code
- message
- retryable
additionalProperties: false
properties:
code:
$ref: "#/components/schemas/ErrorCode"
message:
type: string
maxLength: 500
retryable:
type: boolean
retry_after_seconds:
type: integer
minimum: 1
details:
type: object
doc_url:
type: string
format: uri
description: Where this code is documented.
ErrorEnvelope:
type: object
required:
- error
- request_id
additionalProperties: false
properties:
error:
$ref: "#/components/schemas/ErrorObject"
request_id:
type: string
format: uuid
Platform:
type: string
enum:
- youtube
- tiktok
- instagram
- upload
- direct
JobMode:
type: string
enum:
- captions_only
- auto
- transcribe
JobStatus:
type: string
enum:
- queued
- processing
- awaiting_provider
- succeeded
- failed
- cancelled
JobSource:
type: object
additionalProperties: false
properties:
url:
type: string
format: uri
maxLength: 2048
description: YouTube or TikTok video URL (captions_only); any https media URL for direct sources (AI transcription). Exactly one of url or upload_id.
upload_id:
type: string
format: uuid
description: Id from POST /v1/uploads after the file was PUT and the upload is ready. Exactly one of url or upload_id.
oneOf:
- required:
- url
- required:
- upload_id
JobRequest:
type: object
required:
- source
- mode
additionalProperties: false
description: |
Only source and mode are required. captions_only (1 credit) works for
YouTube and TikTok. auto and transcribe run AI transcription
(transcribe_credits_per_minute per started minute, 60 s minimum) and
need GET /v1/capabilities to report it enabled for the source type;
on the trial they return 402 PLAN_REQUIRED, and while AI transcription
is switched off for the deployment, 422 CAPABILITY_UNAVAILABLE.
recognition_profile and language only apply to AI transcription.
max_credits is an optional ceiling; the charge is
transcribe_credits_per_minute on measured duration (see GET /v1/capabilities).
properties:
source:
$ref: "#/components/schemas/JobSource"
mode:
$ref: "#/components/schemas/JobMode"
language:
type:
- string
- "null"
maxLength: 35
default: null
description: Only applies to AI transcription (auto/transcribe).
caption_languages:
type: array
maxItems: 5
items:
type: string
maxLength: 35
default: []
description: BCP 47 tags in preference order for the caption track, e.g. ["en", "es"]. Empty means the video default.
caption_preference:
type: string
enum:
- prefer_creator
- creator_only
- automatic_only
default: prefer_creator
recognition_profile:
type: string
enum:
- standard
default: standard
description: Only applies to AI transcription (auto/transcribe).
max_credits:
type: integer
minimum: 1
description: Optional ceiling in credits for auto/transcribe. AI transcription costs transcribe_credits_per_minute per started minute after minimum_billable_seconds (see GET /v1/capabilities); a job whose measured cost exceeds the ceiling fails with BUDGET_EXCEEDED before any provider spend. Default covers max_duration_ms. Ignored for captions_only.
webhook_endpoint_id:
type:
- string
- "null"
format: uuid
default: null
description: Endpoint from POST /v1/webhooks that receives job.succeeded / job.failed for this job.
metadata:
type: object
maxProperties: 10
additionalProperties:
type: string
maxLength: 256
propertyNames:
maxLength: 64
default: {}
JobRetryRequest:
type: object
additionalProperties: false
properties:
max_credits:
type: integer
minimum: 1
description: New ceiling in credits; defaults to the original job ceiling.
JobBilling:
type: object
required:
- credits_reserved
- credits_charged
- kind
additionalProperties: false
properties:
credits_reserved:
type: integer
minimum: 0
description: Credits held while the job runs; released or settled when it finishes.
credits_charged:
type: integer
minimum: 0
description: Credits charged after settlement (0 until the job finishes). 1 for a caption transcript, transcribe_credits_per_minute per started minute for AI transcription, 0 for a cached result.
kind:
type: string
enum:
- captions
- ai_transcription
- cached
description: "What the job paid for: captions (1 credit), ai_transcription (per minute), or cached (a reused result, free within the workspace)."
Job:
type: object
required:
- id
- status
- stage
- result_id
- error
- billing
- created_at
additionalProperties: false
properties:
id:
type: string
format: uuid
description: Job id; use with GET /v1/jobs/{id}.
status:
$ref: "#/components/schemas/JobStatus"
description: queued, processing or awaiting_provider are in flight; succeeded, failed and cancelled are final.
stage:
type:
- string
- "null"
enum:
- resolve
- captions
- acquire_audio
- submit_asr
- wait_asr
- finalize
- null
description: Current pipeline step while in flight; null once final.
result_id:
type:
- string
- "null"
format: uuid
description: Transcript id once status is succeeded; fetch with GET /v1/transcripts/{id}. Null otherwise.
error:
anyOf:
- $ref: "#/components/schemas/ErrorObject"
- type: "null"
description: Set only when status is failed; error.retryable says whether POST /v1/jobs/{id}/retry can help.
billing:
$ref: "#/components/schemas/JobBilling"
description: "What this job consumed: caption requests and AI credits."
source:
type: object
required:
- platform
- media_id
- canonical_url
- title
- upload_id
additionalProperties: false
properties:
platform:
$ref: "#/components/schemas/Platform"
media_id:
type:
- string
- "null"
canonical_url:
type:
- string
- "null"
title:
type:
- string
- "null"
upload_id:
type:
- string
- "null"
options:
type: object