Render API reference

const res = await fetch(urls.executionUrl);
const start = await res.json();   // 202 = new job, 200 = already exists
console.log(start.jobId, start.status);

import requests

start = requests.get(urls["executionUrl"], timeout=60).json()
print(start["jobId"], start["status"])

<?php
$start = json_decode(file_get_contents($urls["executionUrl"]), true);
echo $start["jobId"], " ", $start["status"], PHP_EOL;

curl "$EXECUTION_URL"

const res = await fetch("https://api-host/api/v1/render/execute", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_RENDER_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    id: "clip-8f14e45f",
    inputs: [{ url: "https://cdn.example.com/clip.mp4", ext: "mp4" }],
    output: { ext: "m4a" },
    operation: { type: "extract_audio" },
  }),
});
const job = await res.json();
console.log(job);

import uuid, requests

res = requests.post(
    "https://api-host/api/v1/render/execute",
    headers={"Authorization": "Bearer YOUR_RENDER_KEY"},
    json={
        "id": "clip-8f14e45f",
        "inputs": [{"url": "https://cdn.example.com/clip.mp4", "ext": "mp4"}],
        "output": {"ext": "m4a"},
        "operation": {"type": "extract_audio"},
    },
    timeout=60,
)
job = res.json()
print(job)

<?php
$body = [
    "id" => "clip-8f14e45f",
    "inputs" => [["url" => "https://cdn.example.com/clip.mp4", "ext" => "mp4"]],
    "output" => ["ext" => "m4a"],
    "operation" => ["type" => "extract_audio"],
];

$ch = curl_init("https://api-host/api/v1/render/execute");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($body),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_RENDER_KEY",
        "Content-Type: application/json",
    ],
]);
$job = json_decode(curl_exec($ch), true);
print_r($job);

curl -X POST "https://api-host/api/v1/render/execute" \
  -H "Authorization: Bearer YOUR_RENDER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"clip-8f14e45f","inputs":[{"url":"https://cdn.example.com/clip.mp4","ext":"mp4"}],"output":{"ext":"m4a"},"operation":{"type":"extract_audio"}}'

const res = await fetch("https://api-host/api/v1/render/cache", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_RENDER_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    id: "clip-8f14e45f",
    inputs: [{ url: "https://cdn.example.com/clip.mp4", ext: "mp4" }],
    output: { ext: "m4a" },
    operation: { type: "extract_audio" },
  }),
});
const cached = await res.json();   // { cacheId, executionUrl, statusUrl, expiresAt }
console.log(cached);

import uuid, requests

res = requests.post(
    "https://api-host/api/v1/render/cache",
    headers={"Authorization": "Bearer YOUR_RENDER_KEY"},
    json={
        "id": "clip-8f14e45f",
        "inputs": [{"url": "https://cdn.example.com/clip.mp4", "ext": "mp4"}],
        "output": {"ext": "m4a"},
        "operation": {"type": "extract_audio"},
    },
    timeout=60,
)
cached = res.json()
print(cached)

<?php
$body = [
    "id" => "clip-8f14e45f",
    "inputs" => [["url" => "https://cdn.example.com/clip.mp4", "ext" => "mp4"]],
    "output" => ["ext" => "m4a"],
    "operation" => ["type" => "extract_audio"],
];

$ch = curl_init("https://api-host/api/v1/render/cache");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($body),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_RENDER_KEY",
        "Content-Type: application/json",
    ],
]);
$cached = json_decode(curl_exec($ch), true);
print_r($cached);

curl -X POST "https://api-host/api/v1/render/cache" \
  -H "Authorization: Bearer YOUR_RENDER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"clip-8f14e45f","inputs":[{"url":"https://cdn.example.com/clip.mp4","ext":"mp4"}],"output":{"ext":"m4a"},"operation":{"type":"extract_audio"}}'

const res = await fetch(cached.executionUrl);   // or `https://api-host/api/v1/render/execute/${cacheId}`
if (res.status === 404) throw new Error("Cached job not found");
const start = await res.json();
console.log(start.jobId, start.status);

import requests

res = requests.get(cached["executionUrl"], timeout=60)
if res.status_code == 404:
    raise RuntimeError("Cached job not found")
start = res.json()
print(start["jobId"], start["status"])

<?php
$ch = curl_init($cached["executionUrl"]);
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 60]);
$start = json_decode(curl_exec($ch), true);

if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) === 404) {
    throw new RuntimeException("Cached job not found");
}
echo $start["jobId"], " ", $start["status"], PHP_EOL;

curl "https://api-host/api/v1/render/execute/CACHE_ID"

const ws = new WebSocket(job.statusUrl);

ws.onmessage = (event) => {
  const job = JSON.parse(event.data);
  console.log(job.status, job.progress);

  if (job.status === "done") console.log("Download:", job.output.url);
  if (job.status === "failed" || job.status === "not_found") console.error(job.error);
};

# pip install websockets
import asyncio, json, websockets

async def watch(url):
    async with websockets.connect(url) as ws:
        async for message in ws:
            job = json.loads(message)
            print(job["status"], job.get("progress"))
            if job["status"] in ("done", "failed", "not_found"):
                return job

job = asyncio.run(watch(job["statusUrl"]))

<?php
// composer require textalk/websocket:^1.5
require __DIR__ . "/vendor/autoload.php";

$client = new WebSocket\Client($job["statusUrl"], ["timeout" => 900]);

while (true) {
    $job = json_decode($client->receive(), true);
    echo $job["status"], " ", $job["progress"] ?? "", PHP_EOL;

    if (in_array($job["status"], ["done", "failed", "not_found"], true)) {
        break;
    }
}
$client->close();

function watchRender(sseUrl) {
  return new Promise((resolve, reject) => {
    const events = new EventSource(sseUrl);
    events.onmessage = (event) => {
      const job = JSON.parse(event.data);
      console.log(job.status, job.progress);

      if (job.status === "done") { events.close(); resolve(job.output); }
      if (job.status === "failed" || job.status === "not_found") { events.close(); reject(new Error(job.error)); }
    };
  });
}

const output = await watchRender(job.sseStatusUrl);
console.log("Download:", output.url);

import json, requests

def watch_render(sse_url):
    with requests.get(sse_url, stream=True, timeout=900) as stream:
        for line in stream.iter_lines(decode_unicode=True):
            if not line or not line.startswith("data:"):
                continue
            job = json.loads(line[5:])
            print(job["status"], job.get("progress"))
            if job["status"] == "done":
                return job["output"]
            if job["status"] in ("failed", "not_found"):
                raise RuntimeError(job.get("error"))

output = watch_render(job["sseStatusUrl"])
print("Download:", output["url"])

<?php
function watchRender(string $sseUrl): array
{
    $buffer = "";
    $final = null;

    $ch = curl_init($sseUrl);
    curl_setopt_array($ch, [
        CURLOPT_HTTPHEADER => ["Accept: text/event-stream"],
        CURLOPT_TIMEOUT => 900,
        CURLOPT_WRITEFUNCTION => function ($ch, string $chunk) use (&$buffer, &$final) {
            $buffer .= $chunk;
            while (($pos = strpos($buffer, "\n\n")) !== false) {
                $event = substr($buffer, 0, $pos);
                $buffer = substr($buffer, $pos + 2);

                foreach (explode("\n", $event) as $line) {
                    if (!str_starts_with($line, "data:")) {
                        continue;
                    }
                    $job = json_decode(trim(substr($line, 5)), true);
                    echo $job["status"], " ", $job["progress"] ?? "", PHP_EOL;

                    if (in_array($job["status"], ["done", "failed", "not_found"], true)) {
                        $final = $job;
                        return 0; // stop reading, the job has finished
                    }
                }
            }
            return strlen($chunk);
        },
    ]);
    curl_exec($ch);

    if ($final === null) {
        throw new RuntimeException("Status stream ended unexpectedly");
    }
    if ($final["status"] !== "done") {
        throw new RuntimeException($final["error"] ?? "Render failed");
    }
    return $final["output"];
}

$output = watchRender($job["sseStatusUrl"]);
echo "Download: ", $output["url"], PHP_EOL;

curl -N "$SSE_STATUS_URL"

# data: {"job_id":"…","status":"downloading_inputs","progress":22,"output":null,"error":null,…}
# data: {"job_id":"…","status":"done","progress":100,"output":{"url":"https://…","size":98234112,"sizeText":"93.68 MB",…},…}

const ok = (await (await fetch("https://api-host/")).text()) === "OK";
console.log(ok);

import requests

print(requests.get("https://api-host/", timeout=10).text == "OK")

<?php
var_dump(file_get_contents("https://api-host/") === "OK");

curl "https://api-host/"