Interface AudioResponseFormat

Configuration for audio output format.

interface AudioResponseFormat {
    bit_rate?: number;
    delivery?: "inline" | "uri";
    mime_type?:
        | "audio/wav"
        | "audio/mp3"
        | "audio/l16"
        | "audio/alaw"
        | "audio/mulaw"
        | "audio/ogg_opus";
    sample_rate?: number;
    type: "audio";
}

Properties

bit_rate? delivery? mime_type? sample_rate? type

Properties

Optionalbit_rate

bit_rate?: number

Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

Optionaldelivery

delivery?: "inline" | "uri"

The delivery mode for the audio output.

Optionalmime_type

mime_type?:
    | "audio/wav"
    | "audio/mp3"
    | "audio/l16"
    | "audio/alaw"
    | "audio/mulaw"
    | "audio/ogg_opus"

The MIME type of the audio output.

Optionalsample_rate

sample_rate?: number

Sample rate in Hz.

type

type: "audio"

Settings

On This Page

Properties