NAME

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

DESCRIPTION

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

See the examples/ directory in the distribution for examples of how to use this.

POST /realtime/sessions

Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the `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-session

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

Request Body

Content Type: application/json

Example:

{
   "voice" : "ash",
   "input_audio_transcription" : null,
   "input_audio_noise_reduction" : null,
   "turn_detection" : null,
   "tools" : [
      null
   ]
}

Responses

Status Code: 200

Session created successfully.

Content Types:

• application/json

  Example:

  {
     "input_audio_transcription" : null,
     "client_secret" : null,
     "voice" : "ash",
     "turn_detection" : null,
     "tools" : [
        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.