post https://api.heygen.com/v1/streaming.start
This endpoint is used to start the connection for an existing streaming session.
This endpoint is used to start an existing streaming session and establish the connection between the client and the Interactive Avatar. It activates the session, enabling communication and interaction.
Request Body
| Field | Type | Description |
|---|---|---|
session_id | string | The ID of the session that you want to start. |
sdp | object | The Session Description Protocol (SDP) data used to establish the connection. |
sdp.type | string | The type of SDP. |
sdp.sdp | string | The SDP string containing the connection information. |
This request requires the session_id to specify which session to start and the sdp object to provide the necessary session details for establishing the connection.
Response Body
| Field | Type | Description |
|---|---|---|
status | string | The response status. |