Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Fork session

live.sessions.fork(session_id, **kwargs) -> SessionForkResponse
POST
/live/sessions/{session_id}/fork

Fork a stored Live session onto a new WebRTC connection.

Parameters
session_id: str
transport: Transport

WebRTC transport with an SDP offer for the new connection to the forked session.

session: Optional[MediaSessionForkConfigParam]

Optional configuration overrides for the new Live session. Omit this object or send an empty object to inherit the stored session’s settings.

Returns
class SessionForkResponse: …

The created Live session identifier and WebRTC answer. Apply transport.sdp as the peer’s remote answer and wait for session.started on the data channel before sending commands.

session: Session

The newly created Live session. Use its ID for session controls and sideband connections.

transport: Transport

WebRTC transport with the SDP answer.

Fork session

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
response = client.live.sessions.fork(
    session_id="session_id",
    transport={
        "sdp": "x",
        "type": "webrtc",
    },
)
print(response.session)
201 — Example
{
  "session": {
    "id": "id"
  },
  "transport": {
    "sdp": "x",
    "type": "webrtc"
  }
}
Returns Examples
201 — Example
{
  "session": {
    "id": "id"
  },
  "transport": {
    "sdp": "x",
    "type": "webrtc"
  }
}