Skip to content
Primary navigation

Suggested
API Dashboard
API Reference

Audio

ModelsExpand Collapse
type AudioModel string
One of the following:
const AudioModelWhisper1 AudioModel = "whisper-1"
const AudioModelGPT4oTranscribe AudioModel = "gpt-4o-transcribe"
const AudioModelGPT4oMiniTranscribe AudioModel = "gpt-4o-mini-transcribe"
const AudioModelGPT4oMiniTranscribe2025_12_15 AudioModel = "gpt-4o-mini-transcribe-2025-12-15"
const AudioModelGPT4oTranscribeDiarize AudioModel = "gpt-4o-transcribe-diarize"
type AudioResponseFormat string

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.

One of the following:
const AudioResponseFormatJSON AudioResponseFormat = "json"
const AudioResponseFormatText AudioResponseFormat = "text"
const AudioResponseFormatSRT AudioResponseFormat = "srt"
const AudioResponseFormatVerboseJSON AudioResponseFormat = "verbose_json"
const AudioResponseFormatVTT AudioResponseFormat = "vtt"
const AudioResponseFormatDiarizedJSON AudioResponseFormat = "diarized_json"

AudioTranscriptions

Turn audio into text or text into audio.

Create transcription
client.Audio.Transcriptions.New(ctx, body) (*AudioTranscriptionNewResponseUnion, error)
POST/audio/transcriptions
ModelsExpand Collapse
type Transcription struct{…}

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

Text string

The transcribed text.

Logprobs []TranscriptionLogproboptional

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.

Token stringoptional

The token in the transcription.

Bytes []float64optional

The bytes of the token.

Logprob float64optional

The log probability of the token.

Usage TranscriptionUsageUnionoptional

Token usage statistics for the request.

One of the following:
type TranscriptionUsageTokens struct{…}

Usage statistics for models billed by token usage.

InputTokens int64

Number of input tokens billed for this request.

OutputTokens int64

Number of output tokens generated.

TotalTokens int64

Total number of tokens used (input + output).

Type Tokens

The type of the usage object. Always tokens for this variant.

InputTokenDetails TranscriptionUsageTokensInputTokenDetailsoptional

Details about the input tokens billed for this request.

AudioTokens int64optional

Number of audio tokens billed for this request.

TextTokens int64optional

Number of text tokens billed for this request.

type TranscriptionUsageDuration struct{…}

Usage statistics for models billed by audio input duration.

Seconds float64

Duration of the input audio in seconds.

Type Duration

The type of the usage object. Always duration for this variant.

type TranscriptionDiarized struct{…}

Represents a diarized transcription response returned by the model, including the combined transcript and speaker-segment annotations.

Duration float64

Duration of the input audio in seconds.

Segments []TranscriptionDiarizedSegment

Segments of the transcript annotated with timestamps and speaker labels.

ID string

Unique identifier for the segment.

End float64

End timestamp of the segment in seconds.

formatfloat
Speaker string

Speaker label for this segment. When known speakers are provided, the label matches known_speaker_names[]. Otherwise speakers are labeled sequentially using capital letters (A, B, ...).

Start float64

Start timestamp of the segment in seconds.

formatfloat
Text string

Transcript text for this segment.

Type TranscriptTextSegment

The type of the segment. Always transcript.text.segment.

Task Transcribe

The type of task that was run. Always transcribe.

Text string

The concatenated transcript text for the entire audio input.

Usage TranscriptionDiarizedUsageUnionoptional

Token or duration usage statistics for the request.

One of the following:
TranscriptionDiarizedUsageTokens
InputTokens int64

Number of input tokens billed for this request.

OutputTokens int64

Number of output tokens generated.

TotalTokens int64

Total number of tokens used (input + output).

Type Tokens

The type of the usage object. Always tokens for this variant.

InputTokenDetails TranscriptionDiarizedUsageTokensInputTokenDetailsoptional

Details about the input tokens billed for this request.

AudioTokens int64optional

Number of audio tokens billed for this request.

TextTokens int64optional

Number of text tokens billed for this request.

TranscriptionDiarizedUsageDuration
Seconds float64

Duration of the input audio in seconds.

Type Duration

The type of the usage object. Always duration for this variant.

type TranscriptionDiarizedSegment struct{…}

A segment of diarized transcript text with speaker metadata.

ID string

Unique identifier for the segment.

End float64

End timestamp of the segment in seconds.

formatfloat
Speaker string

Speaker label for this segment. When known speakers are provided, the label matches known_speaker_names[]. Otherwise speakers are labeled sequentially using capital letters (A, B, ...).

Start float64

Start timestamp of the segment in seconds.

formatfloat
Text string

Transcript text for this segment.

Type TranscriptTextSegment

The type of the segment. Always transcript.text.segment.

type TranscriptionInclude string
type TranscriptionSegment struct{…}
ID int64

Unique identifier of the segment.

AvgLogprob float64

Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

formatfloat
CompressionRatio float64

Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

formatfloat
End float64

End time of the segment in seconds.

formatfloat
NoSpeechProb float64

Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

formatfloat
Seek int64

Seek offset of the segment.

Start float64

Start time of the segment in seconds.

formatfloat
Temperature float64

Temperature parameter used for generating the segment.

formatfloat
Text string

Text content of the segment.

Tokens []int64

Array of token IDs for the text content.

type TranscriptionStreamEventUnion interface{…}

Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you create a transcription with stream set to true and response_format set to diarized_json.

One of the following:
type TranscriptionTextSegmentEvent struct{…}

Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you create a transcription with stream set to true and response_format set to diarized_json.

ID string

Unique identifier for the segment.

End float64

End timestamp of the segment in seconds.

formatfloat
Speaker string

Speaker label for this segment.

Start float64

Start timestamp of the segment in seconds.

formatfloat
Text string

Transcript text for this segment.

Type TranscriptTextSegment

The type of the event. Always transcript.text.segment.

type TranscriptionTextDeltaEvent struct{…}

Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you create a transcription with the Stream parameter set to true.

Delta string

The text delta that was additionally transcribed.

Type TranscriptTextDelta

The type of the event. Always transcript.text.delta.

Logprobs []TranscriptionTextDeltaEventLogproboptional

The log probabilities of the delta. Only included if you create a transcription with the include[] parameter set to logprobs.

Token stringoptional

The token that was used to generate the log probability.

Bytes []int64optional

The bytes that were used to generate the log probability.

Logprob float64optional

The log probability of the token.

SegmentID stringoptional

Identifier of the diarized segment that this delta belongs to. Only present when using gpt-4o-transcribe-diarize.

type TranscriptionTextDoneEvent struct{…}

Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you create a transcription with the Stream parameter set to true.

Text string

The text that was transcribed.

Type TranscriptTextDone

The type of the event. Always transcript.text.done.

Logprobs []TranscriptionTextDoneEventLogproboptional

The log probabilities of the individual tokens in the transcription. Only included if you create a transcription with the include[] parameter set to logprobs.

Token stringoptional

The token that was used to generate the log probability.

Bytes []int64optional

The bytes that were used to generate the log probability.

Logprob float64optional

The log probability of the token.

Usage TranscriptionTextDoneEventUsageoptional

Usage statistics for models billed by token usage.

InputTokens int64

Number of input tokens billed for this request.

OutputTokens int64

Number of output tokens generated.

TotalTokens int64

Total number of tokens used (input + output).

Type Tokens

The type of the usage object. Always tokens for this variant.

InputTokenDetails TranscriptionTextDoneEventUsageInputTokenDetailsoptional

Details about the input tokens billed for this request.

AudioTokens int64optional

Number of audio tokens billed for this request.

TextTokens int64optional

Number of text tokens billed for this request.

type TranscriptionTextDeltaEvent struct{…}

Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you create a transcription with the Stream parameter set to true.

Delta string

The text delta that was additionally transcribed.

Type TranscriptTextDelta

The type of the event. Always transcript.text.delta.

Logprobs []TranscriptionTextDeltaEventLogproboptional

The log probabilities of the delta. Only included if you create a transcription with the include[] parameter set to logprobs.

Token stringoptional

The token that was used to generate the log probability.

Bytes []int64optional

The bytes that were used to generate the log probability.

Logprob float64optional

The log probability of the token.

SegmentID stringoptional

Identifier of the diarized segment that this delta belongs to. Only present when using gpt-4o-transcribe-diarize.

type TranscriptionTextDoneEvent struct{…}

Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you create a transcription with the Stream parameter set to true.

Text string

The text that was transcribed.

Type TranscriptTextDone

The type of the event. Always transcript.text.done.

Logprobs []TranscriptionTextDoneEventLogproboptional

The log probabilities of the individual tokens in the transcription. Only included if you create a transcription with the include[] parameter set to logprobs.

Token stringoptional

The token that was used to generate the log probability.

Bytes []int64optional

The bytes that were used to generate the log probability.

Logprob float64optional

The log probability of the token.

Usage TranscriptionTextDoneEventUsageoptional

Usage statistics for models billed by token usage.

InputTokens int64

Number of input tokens billed for this request.

OutputTokens int64

Number of output tokens generated.

TotalTokens int64

Total number of tokens used (input + output).

Type Tokens

The type of the usage object. Always tokens for this variant.

InputTokenDetails TranscriptionTextDoneEventUsageInputTokenDetailsoptional

Details about the input tokens billed for this request.

AudioTokens int64optional

Number of audio tokens billed for this request.

TextTokens int64optional

Number of text tokens billed for this request.

type TranscriptionTextSegmentEvent struct{…}

Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you create a transcription with stream set to true and response_format set to diarized_json.

ID string

Unique identifier for the segment.

End float64

End timestamp of the segment in seconds.

formatfloat
Speaker string

Speaker label for this segment.

Start float64

Start timestamp of the segment in seconds.

formatfloat
Text string

Transcript text for this segment.

Type TranscriptTextSegment

The type of the event. Always transcript.text.segment.

type TranscriptionVerbose struct{…}

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

Duration float64

The duration of the input audio.

Language string

The language of the input audio.

Text string

The transcribed text.

Segments []TranscriptionSegmentoptional

Segments of the transcribed text and their corresponding details.

ID int64

Unique identifier of the segment.

AvgLogprob float64

Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

formatfloat
CompressionRatio float64

Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

formatfloat
End float64

End time of the segment in seconds.

formatfloat
NoSpeechProb float64

Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

formatfloat
Seek int64

Seek offset of the segment.

Start float64

Start time of the segment in seconds.

formatfloat
Temperature float64

Temperature parameter used for generating the segment.

formatfloat
Text string

Text content of the segment.

Tokens []int64

Array of token IDs for the text content.

Usage TranscriptionVerboseUsageoptional

Usage statistics for models billed by audio input duration.

Seconds float64

Duration of the input audio in seconds.

Type Duration

The type of the usage object. Always duration for this variant.

Words []TranscriptionWordoptional

Extracted words and their corresponding timestamps.

End float64

End time of the word in seconds.

formatfloat
Start float64

Start time of the word in seconds.

formatfloat
Word string

The text content of the word.

type TranscriptionWord struct{…}
End float64

End time of the word in seconds.

formatfloat
Start float64

Start time of the word in seconds.

formatfloat
Word string

The text content of the word.

AudioTranslations

Turn audio into text or text into audio.

Create translation
client.Audio.Translations.New(ctx, body) (*Translation, error)
POST/audio/translations
ModelsExpand Collapse
type Translation struct{…}
Text string
type TranslationVerbose struct{…}
Duration float64

The duration of the input audio.

Language string

The language of the output translation (always english).

Text string

The translated text.

Segments []TranscriptionSegmentoptional

Segments of the translated text and their corresponding details.

ID int64

Unique identifier of the segment.

AvgLogprob float64

Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

formatfloat
CompressionRatio float64

Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

formatfloat
End float64

End time of the segment in seconds.

formatfloat
NoSpeechProb float64

Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

formatfloat
Seek int64

Seek offset of the segment.

Start float64

Start time of the segment in seconds.

formatfloat
Temperature float64

Temperature parameter used for generating the segment.

formatfloat
Text string

Text content of the segment.

Tokens []int64

Array of token IDs for the text content.

AudioSpeech

Turn audio into text or text into audio.

Create speech
client.Audio.Speech.New(ctx, body) (*Response, error)
POST/audio/speech
ModelsExpand Collapse
type SpeechModel string
One of the following:
const SpeechModelTTS1 SpeechModel = "tts-1"
const SpeechModelTTS1HD SpeechModel = "tts-1-hd"
const SpeechModelGPT4oMiniTTS SpeechModel = "gpt-4o-mini-tts"
const SpeechModelGPT4oMiniTTS2025_12_15 SpeechModel = "gpt-4o-mini-tts-2025-12-15"

AudioVoices

Turn audio into text or text into audio.

AudioVoice Consents

Turn audio into text or text into audio.