NAME

OpenAPI::Client::OpenAI::Path::realtime-transcription_sessions - Documentation for the /realtime/transcription_sessions path.

DESCRIPTION

This document describes the API endpoint at /realtime/transcription_sessions.

PATHS

POST /realtime/transcription_sessions

Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcription_session.update client event.

It responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.

Operation ID

create-realtime-transcription-session

$client->create-realtime-transcription-session( ... );

Parameters

Request Body

Content Type: application/json

Realtime transcription session object configuration.

Example:

{
   "include" : [
      null
   ],
   "input_audio_noise_reduction" : null,
   "input_audio_transcription" : null,
   "turn_detection" : null
}


         

Responses

Status Code: 200

Session created successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
    "id": "sess_BBwZc7cFV3XizEyKGDCGL",
    "object": "realtime.transcription_session",
    "expires_at": 1742188264,
    "modalities": ["audio", "text"],
    "turn_detection": {
      "type": "server_vad",
      "threshold": 0.5,
      "prefix_padding_ms": 300,
      "silence_duration_ms": 200
    },
    "input_audio_format": "pcm16",
    "input_audio_transcription": {
      "model": "gpt-4o-transcribe",
      "language": null,
      "prompt": ""
    },
    "client_secret": null
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.