Skip to main content
POST
Propose object removal

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this request; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Path Parameters

projectId
string
required

The project id.

Required string length: 1 - 200

Body

application/json
assetId
string
required

The recording (asset id) in the composition to remove it from.

Required string length: 1 - 200
startSec
number
required

Where the stretch starts, in the recording's own seconds.

Required range: 0 <= x <= 36000
endSec
number
required

Where it ends; at most 30 seconds after startSec, priced per started 5 seconds.

Required range: 0 <= x <= 36000
atSec
number

A mark: the recording second the object is marked at (inside the stretch).

Required range: 0 <= x <= 36000
x
number

A mark: the point (or a box's left edge), 0-1 across the output frame.

Required range: 0 <= x <= 1
y
number

A mark: the point (or a box's top edge), 0-1 down the output frame.

Required range: 0 <= x <= 1
w
number

A box mark: its width, 0-1 of the output frame. Omit for a point.

Required range: 0 <= x <= 1
h
number

A box mark: its height, 0-1 of the output frame. Omit for a point.

Required range: 0 <= x <= 1
prompt
string

Or name it in words (the mic, the logo on the shirt) instead of a mark.

Maximum string length: 200
compositionId
string

The composition to edit; the project's first when omitted.

Required string length: 1 - 160
threadId
string

Continue this Sigma conversation instead of starting one.

Required string length: 1 - 200

Response

Success.

success
boolean
required
threadId
string
required

The Sigma conversation the proposal is recorded in.

messageId
string
required
projectId
string | null
required

Where it runs; null for a workspace conversation until it is approved.

approval
object
required
{key}
any