POST /realtime/transcription_sessions

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
input_audio_noise_reduction Object No

Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

input_audio_noise_reduction.type String No

Type of noise reduction. near_field is for close-talking microphones such as headphones, far_field is for far-field microphones such as laptop or conference room microphones.

Possible values:

  • "near_field"
  • "far_field"
turn_detection Object No

Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to null to turn off, in which case the client must manually trigger model response. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech. Semantic VAD is more advanced and uses a turn detection model (in conjuction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with "uhhm", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

turn_detection.prefix_padding_ms Integer No

Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

turn_detection.threshold Number No

Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

turn_detection.eagerness String No

Used only for semantic_vad mode. The eagerness of the model to respond. low will wait longer for the user to continue speaking, high will respond more quickly. auto is the default and is equivalent to medium.

Possible values:

  • "medium"
  • "low"
  • "high"
  • "auto"

Default value: "auto"

turn_detection.type String No

Type of turn detection.

Possible values:

  • "server_vad"
  • "semantic_vad"

Default value: "server_vad"

turn_detection.silence_duration_ms Integer No

Used only for server_vad mode. Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.

turn_detection.interrupt_response Boolean No

Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs. Not available for transcription sessions.

Default value: true

turn_detection.create_response Boolean No

Whether or not to automatically generate a response when a VAD stop event occurs. Not available for transcription sessions.

Default value: true

include[] Array No

The set of items to include in the transcription. Current available items are:

  • item.input_audio_transcription.logprobs
input_audio_transcription Object No

Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

input_audio_transcription.prompt String No

An optional text to guide the model's style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models, the prompt is a free text string, for example "expect words related to technology".

input_audio_transcription.model String No

The model to use for transcription, current options are gpt-4o-transcribe, gpt-4o-mini-transcribe, and whisper-1.

Possible values:

  • "gpt-4o-transcribe"
  • "whisper-1"
  • "gpt-4o-mini-transcribe"
input_audio_transcription.language String No

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

modalities[] Array No

The set of modalities the model can respond with. To disable audio, set this to ["text"].

input_audio_format String No

The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, input audio must be 16-bit PCM at a 24kHz sample rate, single channel (mono), and little-endian byte order.

Possible values:

  • "g711_ulaw"
  • "g711_alaw"
  • "pcm16"

Default value: "pcm16"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.