Create Transcription

Transcribes audio into the input language.

POSThttps://api.portkey.ai/v1/audio/transcriptions

Body

multipart/form-data

file*string (binary)

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

model*any of

ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

Example: "whisper-1"

stringenum

languagestring

The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.

promptstring

An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.

response_formatenum

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

jsontextsrtverbose_jsonvtt

temperaturenumber

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

timestamp_granularities[]array of enum

The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.

Response

200

OK

Body

application/json

one of

CreateTranscriptionResponseJson (object)CreateTranscriptionResponseVerboseJson (object)

Response

{
  "text": "text"
}