Create render
curl --request POST \
--url https://api.example.com/v1/workflows/{id}/renders \
--header 'Content-Type: application/json' \
--data '{
"options": {}
}'import requests
url = "https://api.example.com/v1/workflows/{id}/renders"
payload = { "options": {} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({options: {}})
};
fetch('https://api.example.com/v1/workflows/{id}/renders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows/{id}/renders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'options' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows/{id}/renders"
payload := strings.NewReader("{\n \"options\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/workflows/{id}/renders")
.header("Content-Type", "application/json")
.body("{\n \"options\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{id}/renders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"options\": {}\n}"
response = http.request(request)
puts response.read_bodyRenders
Create render
Queue a render. Returns a job handle; poll get-render.
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": {}
}'import requests
url = "https://api.example.com/v1/workflows/{id}/renders"
payload = { "options": {} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({options: {}})
};
fetch('https://api.example.com/v1/workflows/{id}/renders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows/{id}/renders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'options' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows/{id}/renders"
payload := strings.NewReader("{\n \"options\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/workflows/{id}/renders")
.header("Content-Type", "application/json")
.body("{\n \"options\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{id}/renders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"options\": {}\n}"
response = http.request(request)
puts response.read_bodystring
required
Workflow id.
Body
object
Renderer opts: resolution, quality, audio mode override.
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:
| Status | What it means |
|---|---|
queued | Server will pick it up shortly. |
running | Render in progress; check progress (0..1). |
needs_browser | Complex workflow; canvas will pick up on next visit. |
done | result.video_url is populated. |
failed | error 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.Was this page helpful?
⌘I