FastPix Developer Documentation

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

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 <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#how-to-complete-a-stream">Manage streams</a>

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://fastpix.com/docs/getting-started/activate-your-account" target="_blank">See the guide here</a>

Path parameters

streamIdstringRequired

Upon creating a new live stream, FastPix assigns a unique identifier to the stream.

Response

Stream details updated successfully

successboolean

Shows the request status. Returns true for success and false for failure.