Skip to main content
POST
Packaging a finished edit

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
channel
string
required

Plain-language channel brief: audience, voice, positioning, and topics.

Required string length: 1 - 120
asr
object
required

Automatic speech recognition result for the finished edit.

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
topic
string

Main subject, when it is not obvious from the transcript.

Maximum string length: 300
channelName
string

Public channel name used in titles and descriptions when appropriate.

Maximum string length: 120
channelHandle
string

Public handle, including @ if that is how it should appear.

Maximum string length: 120
shorts
object[]
Maximum array length: 20
titleCount
integer

Number of long-form title options to return. 1 to 20.

Required range: 1 <= x <= 20

Published long-form video URL to reference from short-form descriptions, when one exists.

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

packaging
object
required

Titles, description, tags and thumbnail prompts.

passes
number
required

What was billed: how many generation passes this took.

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