Skip to main content
POST
Cut platform-shaped short clips from a finished render.

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
jobId
string
required
Required string length: 1 - 200
platforms
string[]
Maximum array length: 10
Required string length: 1 - 60
maxPerPlatform
integer
Required range: 1 <= x <= 10
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

credits
number
required

What this call actually cost, which is not always what was quoted.

clips
any[]
required

The cut clips, each with its platform and the URL of the file.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

{key}
any