POST
/
audio
/
transcriptions

Authorizations

x-portkey-api-key
string
headerrequired
x-portkey-virtual-key
string
headerrequired

Body

multipart/form-data
file
file
required

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
required

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

language
string

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

prompt
string

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

response_format
enum<string>
default: json

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

Available options:
json,
text,
srt,
verbose_json,
vtt
temperature
number
default: 0

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[]
enum<string>[]

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.

Available options:
word,
segment

Response

200 - application/json

Represents a transcription response returned by model, based on the provided input.

text
string
required

The transcribed text.

Was this page helpful?

Create SpeechCreate Translation