POST /realtime/transcription_sessions
Servers
- https://api.openai.com/v1
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 |
input_audio_noise_reduction.type |
String | No |
Type of noise reduction. Possible values:
|
turn_detection |
Object | No |
Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to |
turn_detection.prefix_padding_ms |
Integer | No |
Used only for |
turn_detection.threshold |
Number | No |
Used only for |
turn_detection.eagerness |
String | No |
Used only for Possible values:
Default value: "auto" |
turn_detection.type |
String | No |
Type of turn detection. Possible values:
Default value: "server_vad" |
turn_detection.silence_duration_ms |
Integer | No |
Used only for |
turn_detection.interrupt_response |
Boolean | No |
Whether or not to automatically interrupt any ongoing response with output to the default
conversation (i.e. 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:
|
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 |
input_audio_transcription.model |
String | No |
The model to use for transcription, current options are Possible values:
|
input_audio_transcription.language |
String | No |
The language of the input audio. Supplying the input language in
ISO-639-1 (e.g. |
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 Possible values:
Default value: "pcm16" |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.