API Reference

Live

Sessions

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fork session

live.sessions.fork(strsession_id, SessionForkParams**kwargs) -> SessionForkResponse

POST/live/sessions/{session_id}/fork

Fork a stored Live session onto a new WebRTC connection.

ParametersExpand Collapse

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.

ReturnsExpand Collapse

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

Python

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

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)

200 example

{
  "session": {
    "id": "id"
  },
  "transport": {
    "sdp": "x",
    "type": "webrtc"
  }
}

Returns Examples

200 example

{
  "session": {
    "id": "id"
  },
  "transport": {
    "sdp": "x",
    "type": "webrtc"
  }
}