API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Audio

ModelsExpand Collapse

enum AudioModel:

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

AudioSpeech

Turn audio into text or text into audio.

Create speech

HttpResponse audio().speech().create(SpeechCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/audio/speech

ModelsExpand Collapse

enum SpeechModel:

AudioTranscriptions

Turn audio into text or text into audio.

Create transcription

TranscriptionCreateResponse audio().transcriptions().create(TranscriptionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/audio/transcriptions

ModelsExpand Collapse

class Transcription:

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

class TranscriptionDiarized:

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

class TranscriptionDiarizedSegment:

A segment of diarized transcript text with speaker metadata.

enum TranscriptionInclude:

class TranscriptionLanguage:

A language detected in transcribed audio.

class TranscriptionSegment:

class TranscriptionStreamEvent: A class that can be one of several variants.union

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.

class TranscriptionTextDeltaEvent:

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.

class TranscriptionTextDoneEvent:

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.

class TranscriptionTextSegmentEvent:

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.

class TranscriptionVerbose:

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

class TranscriptionWord:

AudioTranslations

Turn audio into text or text into audio.

Create translation

TranslationCreateResponse audio().translations().create(TranslationCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/audio/translations

ModelsExpand Collapse

class Translation:

class TranslationVerbose:

AudioVoice Consents

Turn audio into text or text into audio.

AudioVoices

Turn audio into text or text into audio.