DaVinci Resolve APIIntermediateRender

How to Read Render Job Status with the DaVinci Resolve Python API

Use GetRenderJobStatus, JobStatus, and progress data to verify an export result

Read a Render Job by ID during and after rendering, normalize the status response, and distinguish completed, failed, or unavailable states without checking the Deliver page manually.

API

Resolve Scripting API

Language

Python

Resolve

19–20+

Requires

Running Resolve

Syntax

status = project.GetRenderJobStatus(job_id)

Parameters

• The relevant arguments are shown in the complete working example below. Validate paths, object types, and required project state before calling the API method.

Returns

Always validate the returned object, list, identifier, or boolean before continuing to the next automation step.

Complete working Python exampleuse it as a starting point for your own script

import os
import sys
import time
from pathlib import Path


def import_resolve_module():
    try:
        import DaVinciResolveScript as dvr
        return dvr
    except ImportError:
        search_paths = [
            os.environ.get("RESOLVE_SCRIPT_API", ""),
            os.environ.get("RESOLVE_MODULES", ""),
            r"C:\ProgramData\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting\Modules",
            "/opt/resolve/Developer/Scripting/Modules",
            "/opt/BlackmagicDesign/DaVinciResolve/Developer/Scripting/Modules",
            "/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting/Modules",
            str(Path.home() / "Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting/Modules"),
        ]
        for path in search_paths:
            if path and os.path.isdir(path) and path not in sys.path:
                sys.path.append(path)
        import DaVinciResolveScript as dvr
        return dvr


def safe_call(obj, name, *args, **kwargs):
    try:
        fn = getattr(obj, name, None)
        if callable(fn):
            return fn(*args, **kwargs)
    except Exception:
        return None
    return None


def get_project_and_timeline():
    dvr = import_resolve_module()
    resolve = dvr.scriptapp("Resolve")
    if not resolve:
        raise RuntimeError("DaVinci Resolve API is unavailable")

    project_manager = safe_call(resolve, "GetProjectManager")
    project = safe_call(project_manager, "GetCurrentProject") if project_manager else None
    if not project:
        raise RuntimeError("No DaVinci Resolve project is open")

    timeline = safe_call(project, "GetCurrentTimeline")
    if not timeline:
        raise RuntimeError("No active Timeline")

    return resolve, project, timeline



def get_render_status(project, job_id):
    status = safe_call(project, "GetRenderJobStatus", job_id) or {}
    if isinstance(status, dict):
        return {
            "job_id": str(job_id),
            "job_status": str(status.get("JobStatus", "")),
            "completion": status.get("CompletionPercentage", status.get("Completion", "")),
            "raw": status,
        }
    return {"job_id": str(job_id), "job_status": str(status), "completion": "", "raw": status}


resolve, project, timeline = get_project_and_timeline()
job_id = safe_call(project, "AddRenderJob")
if not job_id:
    raise RuntimeError("Render Job was not created")

safe_call(project, "StartRendering", [job_id])
while safe_call(project, "IsRenderingInProgress"):
    print(get_render_status(project, job_id))
    time.sleep(1.0)

print("Final:", get_render_status(project, job_id))

Guide

What the example does

The script creates and starts a Render Job, then periodically queries GetRenderJobStatus while Resolve is rendering. After the export stops, it reads and prints the final status response.

Why status parsing is wrapped in a helper

The exact response dictionary can vary across Resolve versions. A small wrapper can extract common fields such as JobStatus and completion percentage while preserving the raw response for diagnostics.

How to validate the result

After rendering, check for a completed status and then verify that the expected output file actually exists. A stopped render process by itself is not proof that a valid delivery file was produced.

How the example works

Connect to Resolve

Establish a Resolve Scripting API connection and stop early if the application object is unavailable.

Validate the current context

Check the active project, Timeline, Media Pool, source paths, or Render Queue state required by this specific operation.

Run the core API operation

Execute the operation demonstrated in this guide: how to read render job status with the davinci resolve python api.

Validate the result

Check the returned value before the workflow continues. Resolve methods often signal an unavailable object or failed operation with None, False, or an empty result.

Resolve API notes

GetRenderJobStatus() requires the correct current job ID.
IsRenderingInProgress() is convenient for the wait loop, while GetRenderJobStatus() provides job-specific details.
The status dictionary shape can vary between Resolve versions.
Validate both the reported status and the resulting output file.

Common errors

Resolve API is unavailable

Reason: Resolve is closed or Python cannot import/use DaVinciResolveScript.

Fix: Start Resolve and verify the Developer/Scripting/Modules path from the same Python interpreter used by the script.

The method returns None or False

Reason: A required project, Timeline, clip, preset, path, or application state is missing.

Fix: Validate each input and add explicit result checks after important Resolve API calls.

The script only works on one workstation

Reason: Paths or environment assumptions are hard-coded for a single operating system or machine.

Fix: Move paths into configuration and support the required Windows, Linux, and macOS locations explicitly.

Next step

Continue only after the current operation has returned the expected Resolve object or result.

Related API guides

Render