Fork session | Sample

1 parameter · 2 body fields

session_idstringrequired

The ID of the stored Live session to fork.

sessionobjectoptional

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

transportobjectrequired

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

1 status code

201Forked Live session created with a WebRTC answer.

sessionobjectrequired

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

transportobjectrequired

WebRTC transport with the SDP answer.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.fork.create({
  sessionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  transport: {},
  session: {},
});

{
  "session": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "transport": {
    "type": "webrtc",
    "sdp": "example_value"
  }
}

Request

Response