RealTime session create to retrieve Ephemeral Token

[ngelx]

Following PR #545. Added a simple Ephemeral API token creation in order to be used to authenticate browser clients for the Realtime API. Useful to WebRTC integration.

Added Spec and basic documentation on how to use it.

response = client.real_time.create(parameters: { model: "gpt-4o-realtime-preview-2024-12-17" })
puts "ephemeral key: #{response.dig('client_secret', 'value')}"
# => "ephemeral key: ek_abc123"

Then in the client-side application, make a POST request to the Real-Time API with the ephemeral key and the SDP offer.

const OPENAI_REALTIME_URL = 'https://api.openai.com/v1/realtime/sessions'
const MODEL = 'gpt-4o-realtime-preview-2024-12-17'

const response = await fetch(`${OPENAI_REALTIME_URL}?model=${MODEL}`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/sdp',
    'Authorization': `Bearer ${ephemeralKey}`,
    'OpenAI-Beta': 'realtime=v1'
  },
  body: offer.sdp
})

API doc: https://platform.openai.com/docs/api-reference/realtime

All Submissions:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Have you added an explanation of what your changes do and why you'd like us to include them?

[joegaudet]

Awesome! I came her looking for this just now!

[pankaj-awake]

Wow, just what i needed, looking forward to this.

[ngelx]

@alexrudall Any idea when this can be merged? There is anything that need to be changed or fixed?

[alexrudall]

@ngelx thanks for this - will try and test & merge ASAP.

[nekapoor]

@alexrudall certainly don't want to be pushy! Very grateful for all you've done with this library! But any chance you had time to test? Would love to have this feature merged

[alexrudall]

Released in v8.2.0 - thank you @ngelx! @nekapoor

[nekapoor]

amazing, thanks so much @alexrudall! and of course, thank you @ngelx for this PR!