Skip to main content
PATCH
Change a clip

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

clip_id
string
required

The clip's id, from GET /v1/clips

Body

application/json
description
string | null

Up to 5,000 characters; "" clears it

Maximum string length: 5000
tags
string[] | null

Replaces the tags: up to 20 of 1 to 50 characters each; [] clears them

Maximum array length: 20
Required string length: 1 - 50
title
string | null

1 to 500 characters; spaces at either end are removed

Required string length: 1 - 500

Response

200 - application/json

Successful Response

activity_id
string
required

The activity whose recording the clip cuts

created_at
string
required
created_by
string
required

The user_id of the member who made it (as GET /v1/objects/user/records gives it), or apikey:<key_id> for a key

end_time_seconds
number
required
id
string
required
start_time_seconds
number
required
status
enum<string>
required

pending (waiting to be cut), processing (being cut), completed (the video is ready) or failed

Available options:
pending,
processing,
completed,
failed
title
string
required
updated_at
string
required
description
string | null

When video_url and thumbnail_url stop working

share_expires_at
string | null

When share_url closes; null when it is not shared

share_url
string | null

The clip's public page in the app, open to anyone until share_expires_at

tags
string[]
thumbnail_url
string | null

A signed link to the clip's JPEG thumbnail, as video_url; null when there is none

transcript_snippet
string | null

The transcript lines in the clip's range, one Speaker: text line each

video_url
string | null

A signed link that downloads the clip's MP4 with a plain GET until links_expire_at; anyone holding it can. Null until the clip is completed