audio.transcriptions

Create Streaming Transcription (SSE)

Changed on

Create Streaming Transcription (SSE)

post/v1/audio/transcriptions#stream

Request

Request body multipart/form-data

modelstring required
filestring binary

The File object (not file name) to be uploaded. To upload a file and specify a custom file name you should format your request as such:

file=@path/to/your/file.jsonl;filename=custom_name.jsonl

Otherwise, you can just keep the original file name:

file=@path/to/your/file.jsonl
file_urlstring uri nullable

Url of a file to be transcribed

file_idstring nullable

ID of a file uploaded to /v1/files

languagestring nullable

Language of the audio, e.g. 'en'. Providing the language can boost accuracy.

temperaturenumber nullable
streamtrue
diarizeboolean
context_biasstring[]
timestamp_granularitiesTimestampGranularity[]

Granularities of timestamps to include in the response.

Response

Stream of transcription events

Changes

    • breaking

      response property data/oneOf[subschema #3: TranscriptionStreamSegmentDelta]/end list-of-types was widened by adding types null to media type text/event-stream of response 200

    • breaking

      response property data/oneOf[subschema #3: TranscriptionStreamSegmentDelta]/start list-of-types was widened by adding types null to media type text/event-stream of response 200

    • breaking

      response property data/oneOf[subschema #4: TranscriptionStreamDone]/segments/items/end list-of-types was widened by adding types null to media type text/event-stream of response 200

    • breaking

      response property data/oneOf[subschema #4: TranscriptionStreamDone]/segments/items/start list-of-types was widened by adding types null to media type text/event-stream of response 200

    • info

      added the optional property /// to the response with the status