forked from m-bain/whisperX
-
Notifications
You must be signed in to change notification settings - Fork 2
/
swagger.yaml
51 lines (48 loc) · 1.95 KB
/
swagger.yaml
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
openapi: 3.0.3
info:
title: Transcription Service
description: |-
This is a Python server Application that transcribes media files.
The service recieves requests to transcribe file through the endpoint '/transcribe'.
Once a request was received, the server will start the transcription work and post the result to the indicated place when finished.
This service will only process one file at a time and will additional requests while processing is ongoing.
Some useful links:
- [Whisperx](https://github.com/m-bain/whisperX) used for generating the transcriptions.
version: 1.0.0
paths:
/transcribe:
post:
summary: Request the transcription of media
description: This endpoint is used to request the transcription of a media file.
operationId: transcribe
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TranscriptionRequest'
required: true
responses:
'202':
description: Request Accepted - the file processing has begun.
'400':
description: Bad Request - the request body did not contain the expected object.
'529':
description: Service Overloaded - a video is currently being processed. Try again later.
'404':
description: File not found - the requested file could not be located in storage.
components:
schemas:
TranscriptionRequest:
type: object
required: [ audioPath ]
properties:
audioPath:
type: string
description: The path to the file for the transcription.
format: filename
example: 'videos/2022-02-28/abcd-edfh.mk4'
outputDir:
type: string
description: The path to which the server should place the transcription. If not provided the output will be put in the same directory as the source file.
format: directory
example: 'videos/2022-02-28'