Skip to main content
POST
Cut shorts

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
jobId
string
required

A completed video.render job id. Read it from that call’s jobId; confirm GET /v1/jobs/{jobId} reports done first.

Required string length: 1 - 200
Example:

"job_4k1b7d"

projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
platforms
enum<string>[]

Platforms to shape the short-form scripts for, e.g. ["tiktok", "shorts"]. Omit to use service defaults.

Required array length: 1 - 10 elements
Available options:
tiktok,
reels,
shorts,
twitter
maxPerPlatform
integer

Maximum scripts to plan for each platform. 1 to 10.

Required range: 1 <= x <= 10

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

clips
object[]
required

SHORT-FORM SCRIPTS, not rendered files. Each carries the platform it is shaped for, its target length, the segment of the source it came from, why that segment was chosen, and the script itself. To turn one into a video, render it — this pass decides WHAT the shorts should be, which is the expensive judgement; the rendering is a separate job per clip.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

{key}
any