parakeet-mlx-fastapi/openapi.yaml at main · yashhere/parakeet-mlx-fastapi · GitHub

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
openapi: 3.1.0
info:
  title: Parakeet-MLX STT service
  description: High-accuracy English speech-to-text with optional word/char/segment
    timestamps.
  version: 0.0.1
paths:
  /healthz:
    get:
      tags:
        - speech
      summary: Liveness/readiness probe
      operationId: health_healthz_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /transcribe:
    post:
      tags:
        - speech
      summary: Transcribe an audio file
      operationId: transcribe_audio_transcribe_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_transcribe_audio_transcribe_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /debug/cfg:
    get:
      tags:
        - speech
      summary: Show Cfg
      operationId: show_cfg_debug_cfg_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    Body_transcribe_audio_transcribe_post:
      properties:
        file:
          type: string
          format: binary
          title: File
        include_timestamps:
          type: boolean
          title: Include Timestamps
          description: Return char/word/segment offsets
          default: false
        should_chunk:
          type: boolean
          title: Should Chunk
          description: If true (default), split long audio into ~60s VAD-aligned chunks
            for batching
          default: true
      type: object
      required:
        - file
      title: Body_transcribe_audio_transcribe_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TranscriptionResponse:
      properties:
        text:
          type: string
          title: Text
          description: Plain transcription.
        timestamps:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Timestamps
          description: Word/segment/char offsets (see NeMo docs).
      type: object
      required:
        - text
      title: TranscriptionResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError