OpenAI API

CreateTranscriptionRequest

object
* Additional properties are NOT allowed.
filestring(binary)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.

modelAny Of
required

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

Variant 1string
languagestring

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) 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_formatstring

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

Allowed values:jsontextsrtverbose_jsonvtt

Default:json

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.

Default:0

timestamp_granularities[]array[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.

Allowed values:wordsegment

Default:segment

Example

CreateTranscriptionResponseJson

object

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

textstringrequired

The transcribed text.

Example

CreateTranscriptionResponseVerboseJson

object

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

languagestringrequired

The language of the input audio.

durationnumberrequired

The duration of the input audio.

textstringrequired

The transcribed text.

wordsarray[object]

Extracted words and their corresponding timestamps.

Show Child Parameters
segmentsarray[object]

Segments of the transcribed text and their corresponding details.

Show Child Parameters
Example

CreateTranslationRequest

object
* Additional properties are NOT allowed.
filestring(binary)required

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

modelAny Of
required

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

Variant 1string
promptstring

An optional text to guide the model’s style or continue a previous audio segment. The prompt should be in English.

response_formatstring

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

Allowed values:jsontextsrtverbose_jsonvtt

Default:json

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.

Default:0

Example

CreateTranslationResponseJson

object
textstringrequired
Example