/ 
OpenAPI-Client-OpenAI-0.28
⭐ Starred 7 / OpenAPI::Client::OpenAI::Path::audio-transcriptions

NAME

OpenAPI::Client::OpenAI::Path::audio-transcriptions - Documentation for the /audio/transcriptions path.

OPERATIONS

POST /audio/transcriptions

createTranscription

$client->create_transcription({
    body => { ... },
});

Transcribes audio into the input language.

Returns a transcription object in json , diarized_json , or verbose_json format, or a stream of transcript events.

Request body

Content-Type: multipart/form-data

Example:

{
   "text" : "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that.",
   "usage" : {
      "input_token_details" : {
         "audio_tokens" : 14,
         "text_tokens" : 0
      },
      "input_tokens" : 14,
      "output_tokens" : 45,
      "total_tokens" : 59,
      "type" : "tokens"
   }
}

Responses

200 - OK

Content-Type: application/json

Example:

{
   "text" : "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that.",
   "usage" : {
      "input_token_details" : {
         "audio_tokens" : 14,
         "text_tokens" : 0
      },
      "input_tokens" : 14,
      "output_tokens" : 45,
      "total_tokens" : 59,
      "type" : "tokens"
   }
}

Content-Type: text/event-stream

Example:

{
   "text" : "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that.",
   "usage" : {
      "input_token_details" : {
         "audio_tokens" : 14,
         "text_tokens" : 0
      },
      "input_tokens" : 14,
      "output_tokens" : 45,
      "total_tokens" : 59,
      "type" : "tokens"
   }
}

SCHEMAS

AudioResponseFormat

The format of the output, in one of these options: json , text , srt , verbose_json , vtt , or diarized_json . For gpt-4o-transcribe and gpt-4o-mini-transcribe , the only supported format is json . For gpt-4o-transcribe-diarize , the supported formats are json , text , and diarized_json , with diarized_json required to receive speaker annotations.

CreateTranscriptionRequest

Properties:

  • chunking_strategy (anyOf)

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

  • include (array of TranscriptionInclude) - 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 , gpt-4o-mini-transcribe , and gpt-4o-mini-transcribe-2025-12-15 . This field is not supported when using gpt-4o-transcribe-diarize .

  • known_speaker_names (array of string) - Optional list of speaker names that correspond to the audio samples provided in known_speaker_references[] . Each entry should be a short identifier (for example customer or agent ). Up to 4 speakers are supported.

  • known_speaker_references (array of string) - Optional list of audio samples (as data URLs ) that contain known speaker references matching known_speaker_names[] . Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by file .

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

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

  • prompt (string) - An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. This field is not supported when using gpt-4o-transcribe-diarize .

  • response_format (AudioResponseFormat)

    See "AudioResponseFormat" below for shape.

  • stream (anyOf)

  • 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: 0

  • timestamp_granularities (array of 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. This option is not available for gpt-4o-transcribe-diarize .

    Default: ["segment"]

CreateTranscriptionResponseStreamEvent

See https://platform.openai.com/docs/api-reference for details.

TranscriptionInclude

See https://platform.openai.com/docs/api-reference for details.

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.