API Reference

Live

Sessions

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fork session

$ openai live:sessions fork

POST/live/sessions/{session_id}/fork

Fork a stored Live session onto a new WebRTC connection.

ParametersExpand Collapse

--session-id: string

The ID of the stored Live session to fork.

--transport: object { sdp, type }

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

--session: optional object { client, delegation, store }

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

SessionForkResponse: object { session, transport }

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: object { id }

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

transport: object { sdp, type }

WebRTC transport with the SDP answer.

Fork session

CLI Tool

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

openai live:sessions fork \
  --api-key 'My API Key' \
  --session-id session_id \
  --transport '{sdp: x, type: webrtc}'

200 example

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

Returns Examples

200 example

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