Livepeer Video Servicesdocs
Search
⌘ K
GuidesAPI Reference
Dashboard
GuidesAPI ReferenceDashboard
DOCUMENTATION
Overview
Stream
OverviewPOST create a streamGET retrieve a streamGET a list of streamsPATCH toggle recordingPATCH update a streamDELETE a stream
Session
OverviewGET retrieve a sessionGET a list of sessionsGET a list of recorded sessions
Multistream target
OverviewPOST create a targetGET retrieve a targetGET a list of targetsPATCH update a targetDELETE a target
Ingest
Authentication
Errors
API key
API Reference / Stream / Record on Off

PATCH toggle recording

PATCH /stream/{id}/record can only modify a stream object. You cannot modify the record value on a session object or the historic stream objects with a parentId (stream objects representing a single live stream session).

The record value is inherited by all future child session objects. Child session objects are read-only.

Turn recording on

curl -X PATCH https://livepeer.com/api/stream/{id}/record \
-H 'content-type: application/json' \
-H 'authorization: Bearer {api-key}' \
-d '{"record":true}'

Turn recording off

curl -X PATCH https://livepeer.com/api/stream/{id}/record \
-H 'content-type: application/json' \
-H 'authorization: Bearer {api-key}' \
-d '{"record":false}'

A 204 no content success status response indicates the record value was updated.