API Reference

Live

Sessions

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fork session

SessionForkResponse live().sessions().fork(SessionForkParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/live/sessions/{session_id}/fork

Fork a stored Live session onto a new WebRTC connection.

ParametersExpand Collapse

SessionForkParams params

Optional<String> sessionId

Transport transport

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

Optional<MediaSessionForkConfig> session

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

Java

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.live.sessions.SessionForkParams;
import com.openai.models.live.sessions.SessionForkResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        SessionForkParams params = SessionForkParams.builder()
            .sessionId("session_id")
            .transport(SessionForkParams.Transport.builder()
                .sdp("x")
                .build())
            .build();
        SessionForkResponse response = client.live().sessions().fork(params);
    }
}

200 example

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

Returns Examples

200 example

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