Start render

Start render

curl --request POST \
  --url https://api.renderjuice.com/api/external/v1/jobs/{id}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestedRenderConfig": {
    "colorManagementPreset": "aces",
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "renderEngine": "CYCLES",
    "compositorDevice": "CPU",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "resolution": [
      1
    ],
    "resolutionPercentage": 16384,
    "outputFormat": "PNG",
    "fps": 1,
    "useTiling": true,
    "tileSize": 1,
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "minimumRam": 1
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "normalizedSeconds": 123,
  "previewUrl": "<string>",
  "failedReason": {
    "name": "<string>",
    "type": "<string>"
  },
  "requestedConfig": "<unknown>",
  "finalConfig": "<unknown>",
  "output": {
    "isDeletedForClient": true
  },
  "isAnalysisSkipped": true,
  "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "analysis": "<unknown>",
  "sceneFile": "<unknown>"
}

POST

jobs

{id}

render

Start render

curl --request POST \
  --url https://api.renderjuice.com/api/external/v1/jobs/{id}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestedRenderConfig": {
    "colorManagementPreset": "aces",
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "renderEngine": "CYCLES",
    "compositorDevice": "CPU",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "resolution": [
      1
    ],
    "resolutionPercentage": 16384,
    "outputFormat": "PNG",
    "fps": 1,
    "useTiling": true,
    "tileSize": 1,
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "minimumRam": 1
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "normalizedSeconds": 123,
  "previewUrl": "<string>",
  "failedReason": {
    "name": "<string>",
    "type": "<string>"
  },
  "requestedConfig": "<unknown>",
  "finalConfig": "<unknown>",
  "output": {
    "isDeletedForClient": true
  },
  "isAnalysisSkipped": true,
  "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "analysis": "<unknown>",
  "sceneFile": "<unknown>"
}

Workflow

Ensure job status is validated (poll GET /jobs/{id} after starting validation)
Call this endpoint with your render configuration
Poll GET /jobs/{id} until status is completed
Retrieve outputs via GET /jobs/{id}/downloads

colorManagementPreset is required. Use default in most cases, or aces if your project uses ACES color management. All other fields are optional and will use values detected during validation.

Authorizations

Authorization

string

header

required

API key authentication. Format: Bearer RJ-XXX.... Get your API key from the Renderjuice dashboard.

Path Parameters

string<uuid>

required

Unique identifier (UUID) of the job Unique identifier of the job

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

requestedRenderConfig

object

required

Configuration specifying how the job should be rendered, including output settings, frame ranges, and rendering options.

Show child attributes

requestedRenderConfig.colorManagementPreset

enum<string>

required

Available options:

aces,

default

requestedRenderConfig.frameRanges

string[]

requestedRenderConfig.notes

string

requestedRenderConfig.renderEngine

enum<string>

Available options:

CYCLES,

BLENDER_EEVEE,

BLENDER_EEVEE_NEXT,

BLENDER_WORKBENCH

requestedRenderConfig.compositorDevice

enum<string>

Available options:

CPU,

GPU

requestedRenderConfig.computeDeviceType

enum<string>

Available options:

CUDA,

OPTIX

requestedRenderConfig.gpuCount

integer

Required range: x > 0

requestedRenderConfig.sampleCount

integer | null

Required range: x > 0

requestedRenderConfig.denoisingEnabled

boolean

requestedRenderConfig.denoiserType

enum<string>

Available options:

OPTIX,

OPENIMAGEDENOISE

requestedRenderConfig.resolution

integer[]

Required array length: 2 elements

Required range: x > 0

requestedRenderConfig.resolutionPercentage

number

Required range: 1 <= x <= 32767

requestedRenderConfig.outputFormat

enum<string>

Available options:

PNG,

TIFF,

JPEG,

AVIJPEG,

AVIRAW,

TARGA,

TARGA_RAW,

BMP,

HDR,

IRIS,

OPEN_EXR,

OPEN_EXR_MULTILAYER,

FFMPEG,

CINEON,

DPX,

JPEG2000,

WEBP

requestedRenderConfig.fps

number

Required range: x > 0

requestedRenderConfig.useTiling

boolean

requestedRenderConfig.tileSize

integer

Required range: x > 0

requestedRenderConfig.outputSettings

object

Show child attributes

requestedRenderConfig.outputSettings.colorMode

enum<string> | null

Available options:

BW,

RGB,

RGBA

requestedRenderConfig.outputSettings.colorDepth

enum<string> | null

Available options:

8,

10,

12,

16,

32

requestedRenderConfig.outputSettings.exrCodec

enum<string> | null

Available options:

NONE,

PIZ,

RLE,

PXR24,

ZIP,

ZIPS,

B44,

B44A,

DWAA,

DWAB

requestedRenderConfig.outputSettings.tiffCodec

enum<string> | null

Available options:

NONE,

DEFLATE,

LZW,

PACKBITS

requestedRenderConfig.outputSettings.compression

number | null

requestedRenderConfig.outputSettings.quality

number | null

requestedRenderConfig.minimumRam

number

Required range: x > 0

Response

200 - application/json

Success

string<uuid>

required

Unique identifier of the job

Example:

"123e4567-e89b-12d3-a456-426614174000"

status

enum<string>

required

Current status of the job

Available options:

created,

validating,

validated,

rendering,

finalizing,

completed,

failed,

canceled,

booting,

suspended

Example:

"completed"

workspaceId

string<uuid>

required

ID of the workspace this job belongs to

createdAt

string<date-time>

required

ISO 8601 timestamp when the job was created

updatedAt

string<date-time>

required

ISO 8601 timestamp when the job was last updated

userId

string<uuid>

ID of the user who created the job

rootFolderId

string<uuid> | null

ID of the root folder containing the job files

normalizedSeconds

number

Normalized rendering time in seconds (adjusted for GPU performance)

previewUrl

string<uri> | null

URL to a preview image of the rendered output, if available

failedReason

object

Details about why the job failed, if applicable

Show child attributes

failedReason.name

string

required

Name of the error that caused the failure

failedReason.type

string

required

Type or category of the error

requestedConfig

any | null

Override configuration that was requested for this job

finalConfig

any | null

Final configuration that was used for rendering (may differ from requested)

output

object

Information about the job output files

Show child attributes

output.isDeletedForClient

boolean

required

Whether the output files have been deleted from client-accessible storage

isAnalysisSkipped

boolean

Whether scene file analysis was skipped for this job

analysisId

string<uuid> | null

ID of the analysis associated with this job

analysis

any | null

Analysis results for the scene file

sceneFile

any | null

Information about the scene file used for rendering

Start validation

Cancel job

⌘I

Overview

API

Webhooks

Workflow

Authorizations

Path Parameters

Body

Response

Overview

API

Webhooks

​Workflow

Authorizations

Path Parameters

Body

Response

Workflow