WebRTC
Last updated April 16, 2026
WebRTC peer connection establishment
Get server-side ICE candidates for a WebRTC leg (trickle ICE)
Parameters
| Name | In | Type | | Description |
|---|
id | path | string | required | Leg ID |
Responses
200
Buffered ICE candidates| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
status | string | required | |
400
Leg is not a WebRTC leg| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
404
Leg not found| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
Send a remote ICE candidate to a WebRTC leg (trickle ICE)
Parameters
| Name | In | Type | | Description |
|---|
id | path | string | required | Leg ID |
Responses
200
Candidate added| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
status | string | required | |
400
Invalid JSON or leg is not a WebRTC leg| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
404
Leg not found| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
500
Failed to add ICE candidate| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
Establish a WebRTC leg via SDP offer/answer
Request Body
| Field | Type | | Description |
|---|
sdp | string | required | SDP offer from the browser |
Responses
200
SDP answer with leg ID| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
status | string | required | |
400
Invalid JSON or invalid SDP offer| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |
500
Peer connection, track creation, or answer generation failed| Field | Type | | Description |
|---|
instance_id | string | optional | Instance identifier |
error | string | required | Error message |