This endpoint marks a livestream as completed by stopping the active stream and transitioning its status to idle. It is typically used after a livestream session has ended.

This operation only works when the stream is in the active state.

Completing a stream can help finalize the session and trigger post-processing events like VOD generation.

Example

A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from active to idle, indicating it's officially completed.

Related guide Manage streams