Transcribes audio into the input language.

POST /audio/transcriptions
Api key auth
multipart/form-data

Body Required

  • file string(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.

  • model string Required

    ID of the model to use. The options are gpt-4o-transcribe, gpt-4o-mini-transcribe, and whisper-1 (which is powered by our open source Whisper V2 model).

    Any of:
    string-1 string string-2 string
  • language string

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

    The format of the output, in one of these options: json, text, srt, verbose_json, or vtt. For gpt-4o-transcribe and gpt-4o-mini-transcribe, the only supported format is json.

    Values are json, text, srt, verbose_json, or vtt. Default value is json.

  • temperature number

    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 value is 0.

  • include[] array[string]

    Additional information to include in the transcription response. logprobs will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. logprobs only works with response_format set to json and only with the models gpt-4o-transcribe and gpt-4o-mini-transcribe.

    Value is logprobs. Default value is [] (empty).

  • 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.

    Values are word or segment. Default value is ["segment"].

  • stream boolean | null

    If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section of the Speech-to-Text guide for more information.

    Note: Streaming is not supported for the whisper-1 model and will be ignored.

    Default value is false.

Responses

  • 200

    OK

    One of:
    CreateTranscriptionResponseJson object CreateTranscriptionResponseVerboseJson object

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

    Hide attributes Show attributes
    • text string Required

      The transcribed text.

    • logprobs array[object]

      The log probabilities of the tokens in the transcription. Only returned with the models gpt-4o-transcribe and gpt-4o-mini-transcribe if logprobs is added to the include array.

      A log probability object.

      Hide logprobs attributes Show logprobs attributes object
      • token string Required

        The token that was used to generate the log probability.

      • logprob number Required

        The log probability of the token.

      • bytes array[integer] Required

        The bytes that were used to generate the log probability.
POST /audio/transcriptions 
curl \
 --request POST 'https://api.openai.com/v1/audio/transcriptions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: multipart/form-data" \
 --form "file=@file" \
 --form "model=gpt-4o-transcribe" \
 --form "language=string" \
 --form "prompt=string" \
 --form "response_format=json" \
 --form "temperature=0" \
 --form "timestamp_granularities[][]=segment" \
 --form "stream=false"
Response examples (200) 
{
  "text": "string",
  "logprobs": [
    {
      "token": "string",
      "logprob": 42.0,
      "bytes": [
        42
      ]
    }
  ]
}
{
  "language": "string",
  "duration": 42.0,
  "text": "string",
  "words": [
    {
      "word": "string",
      "start": 42.0,
      "end": 42.0
    }
  ],
  "segments": [
    {
      "id": 42,
      "seek": 42,
      "start": 42.0,
      "end": 42.0,
      "text": "string",
      "tokens": [
        42
      ],
      "temperature": 42.0,
      "avg_logprob": 42.0,
      "compression_ratio": 42.0,
      "no_speech_prob": 42.0
    }
  ]
}