Skip to main content
GET
Read edit proposal

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

jobId
string
required

Review-mode footage parent job id returned by POST /v1/video/edit.

Required string length: 1 - 200

Query Parameters

after
integer

Zero-based flat-cut offset already consumed; defaults to 0.

Required range: 0 <= x <= 9007199254740991
limit
integer

Maximum cut decisions to return; defaults to 50 and never exceeds 100.

Required range: 1 <= x <= 100

Response

Success.

success
boolean
required
jobId
string
required

Review-mode footage parent job id.

cuts
object[]
required

Bounded proposed-cut page.

page
object
required

Bounded proposal pagination metadata.

status
enum<string>

awaiting_review: approve it. approved: its render finished and it can be revised.

Available options:
awaiting_review,
approved
proposal
object

Proposal identity and version.

topics
object[]

Outline topics with timings. Pass ids as droppedTopicIds or shortTopicIds to video.edit.approve.

moments
object[]

Standalone-short candidates, best score first. Pass ids as shortMomentIds to video.edit.approve.

{key}
any