Cut.ProDocs
Monitoring

List clips of a broadcast

Returns the clips this workspace got from one broadcast, best rated first by default. While the broadcast is on air, new clips land every 10 minutes, so poll this list rather than waiting for the broadcast to end.

A clip with an edit_id is ready to render or post; one without it renders with the default layout through POST /monitors/{id}/broadcasts/{broadcastId}/clips/{clipId}/render. Returns 410 once the recording was purged.

Authorization

apiKey
X-Api-Key<token>

In: header

Path Parameters

id*string
Match^[0-9]{1,19}$
broadcastId*string

Query Parameters

page?number

Page number (default: 1)

Range1 <= value
limit?number

Items per page (default: 20, max: 100)

Range1 <= value <= 100
sort?string

Value in

  • "rating"
  • "duration"
  • "title"
  • "created_at"
order?string

Value in

  • "asc"
  • "desc"
min_rating?number

Only clips with rating at or above this value

Range0 <= value <= 10
max_rating?number

Only clips with rating at or below this value

Range0 <= value <= 10

Response Body

application/json

application/json

application/json

application/json

GET
/monitors/{id}/broadcasts/{broadcastId}/clips
curl -X GET "https://example.com/monitors/string/broadcasts/string/clips"
{  "clips": [    {      "id": "string",      "title": "string",      "description": "string",      "rating": 0,      "started_at": "string",      "ended_at": "string",      "duration": 0,      "thumbnail_url": "string",      "play_url": "string",      "edit_id": "string",      "render_id": "string",      "rendering": true    }  ],  "pagination": {    "current_page": 0,    "total_pages": 0,    "total_count": 0,    "has_next_page": true,    "has_previous_page": true,    "limit": 0  }}

List broadcasts of a live monitor GET

Returns the channel's broadcasts, newest first, each with how many clips this workspace got from it. A broadcast with `ended_at: null` is on air and keeps producing clips every 10 minutes while the monitor is on. Only `live` monitors have broadcasts: a `video` monitor answers `400 INVALID_OBSERVING_TYPE`, and its clips arrive as regular submissions in `GET /clips`.

Apply template to broadcast clips POST

Applies one of your templates to every clip of a broadcast, or to the `clip_ids` given, in the background. Each clip's `edit_id` shows up in `GET /monitors/{id}/broadcasts/{broadcastId}/clips` as it is done. To template every future clip instead, set `template_id` on the monitor. Only one batch runs at a time per account: another one answers `429`.