Skip to main content
POST
Finalize a draft render

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+$

Path Parameters

jobId
string
required

The draft render job id: the jobId of a draft: true render.

Required string length: 1 - 200
Example:

"job_4k1b7d"

Body

application/json
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

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

jobId
string
required

Poll GET /v1/jobs/{jobId}. When that job reports status: "done", the finished file is job.artifacts.download. Video renders expose an origin URL; private 3D artifacts expose an authenticated API handoff that redirects to a short-lived origin URL.

Example:

"job_4k1b7d"

status
string
required

Acceptance, not completion. The work has not started when this returns.

Allowed value: "queued"
draftJobId
string
required

The draft this render finalizes.

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