Delete a Stream
Delete a stream, stopping it if it is live.
Overview
Deletes a stream. If the stream is live, processing stops and outputs are finalised; a scheduled stream is cancelled. The stream’s status becomes4
(ended).
Deleting does not erase the stream’s history: you can still call
GET /stream/{stream_id} afterwards to read its final
state. Streams stop on their own at their end_time; use this endpoint to end
one earlier.
Errors
404- No stream with this ID belongs to your team.422- Invalidstream_id.
Related endpoints
Authorizations
The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
Path Parameters
Identifier of the stream to delete.
Response
Deletion confirmation.
The response is of type Delete Stream Response · object.