Skip to main content
POST
/
v1
/
workflows
/
{id}
/
renders
Create render
curl --request POST \
  --url https://api.example.com/v1/workflows/{id}/renders \
  --header 'Content-Type: application/json' \
  --data '{
  "options": {}
}'
id
string
required
Workflow id.

Body

options
object
Renderer opts: resolution, quality, audio mode override.
Supports Idempotency-Key.

Response

{
  "job_id":   "job_lq3z9m_8fa1c0",
  "status":   "queued",
  "simple":   true,
  "poll_url": "/v1/workflows/wf_xyz/renders/job_lq3z9m_8fa1c0"
}
status is one of:
StatusWhat it means
queuedServer will pick it up shortly.
runningRender in progress; check progress (0..1).
needs_browserComplex workflow; canvas will pick up on next visit.
doneresult.video_url is populated.
failederror is populated.
“Simple” = one shot, no audio tracks, no captions, no audio mixing. Simple renders run end-to-end on our infrastructure. Complex workflows are flagged needs_browser until the platform’s full-fidelity render path picks them up.