Get a Render Job

Poll a single async render job by id until it finalizes, then read its result or its actionable error.

Updated

GET
/v1/studio/render-jobs/{id}
curl -X GET "https://api.orshot.com/v1/studio/render-jobs/<ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Fetch one async render job by id. Poll it until finished is true, then read result (on success) or error (on failure).

Endpoint
GET https://api.orshot.com/v1/studio/render-jobs/:id

Poll for the result#

JavaScript
let job;
do {
  await new Promise((r) => setTimeout(r, 5000));
  const res = await fetch(`https://api.orshot.com/v1/studio/render-jobs/${id}`, {
    headers: { Authorization: "Bearer <ORSHOT_API_KEY>" },
  });
  job = await res.json();
} while (!job.finished);

if (job.status === "succeeded") {
  // job.result.data.content → the rendered file URL
} else {
  // job.error tells you what to fix; job.error_code is stable for branching
}

The response is the job object. Polling does not count against your render rate limit; a sensible interval is 3 to 10 seconds.

  • A job id that does not exist in your workspace answers 404 (job-not-found). Job ids are workspace-scoped, so a foreign id is never distinguishable from a missing one.
  • A non-integer id answers 400 (invalid-job-id).
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