OpenAI API (unofficial showcase)
POST/live/sessions/{session_id}/fork

Fork session

Fork a stored Live session onto a new WebRTC connection.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

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 carrying the offer SDP in a creation request or answer SDP in its response.

7 status codes
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 carrying the offer SDP in a creation request or answer SDP in its response.
400Invalid Live session request.
errorobjectrequired
404Invalid session ID.
413The Live session request exceeds the supported size limit.
errorobjectrequired
429The session could not start because a rate or quota limit was exceeded.
errorobjectrequired
500An internal error occurred. The response body is plain text.
503The session is temporarily unavailable.
errorobjectrequired

Error handling

A 400 is returned: Invalid Live session request. A 404 is returned: Invalid session ID. A 413 is returned: The Live session request exceeds the supported size limit. A 429 is returned: The session could not start because a rate or quota limit was exceeded. A 500 is returned: An internal error occurred. The response body is plain text. A 503 is returned: The session is temporarily unavailable.