Cancel a Render Job
Cancel an async render job that has not started yet. Running renders complete and bill normally.
Updated
POST
/v1/studio/render-jobs/{id}/cancelcurl -X POST "https://api.orshot.com/v1/studio/render-jobs/<ID>/cancel" \
-H "Authorization: Bearer <ORSHOT_API_KEY>"const res = await fetch("https://api.orshot.com/v1/studio/render-jobs/<ID>/cancel", {
method: "POST",
headers: {
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});
const data = await res.json();import requests
response = requests.post(
"https://api.orshot.com/v1/studio/render-jobs/<ID>/cancel",
headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
)
data = response.json()$ch = curl_init("https://api.orshot.com/v1/studio/render-jobs/<ID>/cancel");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer <ORSHOT_API_KEY>",
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);require "net/http"
require "json"
uri = URI("https://api.orshot.com/v1/studio/render-jobs/<ID>/cancel")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)Cancel an async render job that is still queued.
POST https://api.orshot.com/v1/studio/render-jobs/:id/cancelOnly queued jobs can be canceled: nothing has rendered, so nothing is billed. The response is the job object with status: "canceled".
When cancel is refused#
| Job state | Response | Meaning |
|---|---|---|
processing | 409 job-not-cancelable | The render is already running. It completes and is billed normally; poll it, or simply ignore the result. |
succeeded / failed / canceled | 409 job-already-finished | The job already finished; there is nothing to cancel. |
| not in your workspace | 404 job-not-found | Unknown id (job ids are workspace-scoped). |
Was this page helpful?
Ready to automate?
Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.
Get your API key- Image, PDF and video generation via API
- Visual editor with AI and smart layouts
- Zapier, Make, MCP and 50+ integrations
- White-label embed for your own app
- 30 free credits — no credit card required