Skip to Content
Cut.ProDocs
Live clipping: monitored channels

Update a monitor

Changes only the fields sent; null clears template_id and the duration limits. enabled follows the same rules as start and stop. Refusals: 400 INVALID_DURATION_RANGE, 402, 403, 404, 409 MINIMUM_MONITORING_TIME.

Authorization

apiKey
headerX-Api-Key<token>

Path Parameters

id*string

Monitor id, from GET /monitors

Match^[0-9]{1,19}$

Request Body

  1. body
enabled?boolean
strategy_id?string

ID of a clipping strategy. On create, omit to use the default AI settings

Match^[0-9]{1,19}$
template_id?||

ID of an edit template from GET /templates; null = none

Match^[0-9]{1,19}$
video_min_duration?|
Range1 <= value <= 3600
video_max_duration?|
Range1 <= value <= 3600
days_of_week?array<|>
hours_of_day?array<array<|>>

Response Body

Response for status 200

application/json
  1. response
id*string

Monitor id, used in every /monitors/{id} route

platform*string
Value in"youtube""twitch""kick"
username*string

Channel handle on the platform

display_name*||

Channel name as shown on the platform

avatar_url*string|null|null
enabled*boolean

true while the monitor is on. It can also turn itself off when the balance runs out

enabled_at*||

ISO 8601 timestamp of when the current monitoring period started; null while off. Stopping is refused for the first 10 minutes after it.

strategy_id*string

Clipping strategy applied to every clip

template_id*||

Edit template applied to every clip; null = none

type*"live"
Value in"live"
on_air*boolean

true while the channel is broadcasting

broadcasts_count*number

Broadcasts recorded since the channel was first monitored

clips_count*number

Clips this workspace got from the channel's broadcasts whose recording is still kept

last_broadcast_at*||

ISO 8601 timestamp of when the latest broadcast started

thumbnail_url*||

Cover of the latest broadcast. Signed URL, time-limited

next_batch*||

Progress of the next batch; null unless the broadcast is on air and the monitor is on

batch_credits*number

Credits the next 10-minute batch of this channel costs your workspace, after any discount

PATCH
/monitors/{id}
Example Request
curl -X PATCH 'https://api.cut.pro/api/v1/monitors/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "platform": "youtube",  "username": "string",  "display_name": null,  "avatar_url": null,  "enabled": true,  "enabled_at": null,  "strategy_id": "string",  "template_id": null,  "type": "live",  "on_air": true,  "broadcasts_count": 0,  "clips_count": 0,  "last_broadcast_at": null,  "thumbnail_url": null,  "next_batch": null,  "batch_credits": 0}