DaVinci Resolve APIIntermediateRender

How to Create a Render Job with the DaVinci Resolve Python API

Configure the preset, range, and output settings first, then call AddRenderJob

Follow the correct Render Queue order: choose or load a preset, apply the final Render Settings and range, create the job, and retain the returned job ID for safe targeted execution.

API

Resolve Scripting API

Language

Python

Resolve

19–20+

Requires

Running Resolve

Syntax

job_id = project.AddRenderJob()

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 create_render_job(project, output_dir: Path, base_name: str):
    output_dir.mkdir(parents=True, exist_ok=True)

    safe_call(project, "SetRenderRange", "Entire Timeline")
    safe_call(project, "SetRenderSettings", {
        "TargetDir": str(output_dir),
        "CustomName": base_name,
        "ExportVideo": True,
        "ExportAudio": True,
        "IndividualClips": False,
        "Format": "mov",
    })

    job_id = safe_call(project, "AddRenderJob")
    if not job_id:
        raise RuntimeError("AddRenderJob did not create a Render Job")

    return job_id


resolve, project, timeline = get_project_and_timeline()
job_id = create_render_job(project, Path.home() / "Resolve_API_Render", "api_job_test")
print("Render job created:", job_id)
print("Queue:", safe_call(project, "GetRenderJobs") or safe_call(project, "GetRenderJobList") or [])

Guide

What the example does

The script selects an Entire Timeline render, applies the basic output configuration, and calls AddRenderJob(). The returned value is retained as the identifier for the newly created task.

Why the order matters

A Render Job captures the active delivery configuration when it is added to the queue. TargetDir, CustomName, format, codec, and range should therefore be finalized before AddRenderJob().

What to do with the job ID

Use the returned ID to start only that task with StartRendering and to read its status with GetRenderJobStatus. This is safer than launching the entire queue without arguments.

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 create a render job 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

AddRenderJob() can return an empty value when the Deliver configuration is invalid.
Verify that an active Timeline exists before creating a job.
If the queue already contains old tasks, start the new job by its own ID.
If you need different settings, configure them and create a new Render Job instead of assuming the queued one will update.

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