Create job

Create job

curl --request POST \
  --url https://api.renderjuice.com/api/external/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>"
}
'

import requests

url = "https://api.renderjuice.com/api/external/v1/jobs"

payload = { "slug": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({slug: '<string>'})
};

fetch('https://api.renderjuice.com/api/external/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "normalizedSeconds": 123,
  "previewUrl": "<string>",
  "failedReason": {
    "name": "<string>",
    "type": "VALIDATION_FAILED",
    "errorDetails": {}
  },
  "requestedConfig": {
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "blenderVersionForRender": "<string>",
    "colorManagementPreset": "aces",
    "renderEngine": "CYCLES",
    "compositorDevice": "CPU",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "denoisingUseGpu": true,
    "persistentDataEnabled": true,
    "resolution": [
      1
    ],
    "resolutionPercentage": 16384,
    "outputFormat": "PNG",
    "outputMediaType": "IMAGE",
    "fps": 16384,
    "fpsBase": 500000.000005,
    "videoOutput": true,
    "useTiling": true,
    "tileSize": 1,
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "minimumRam": 1,
    "activeCamera": "<string>",
    "activeViewLayer": "<string>"
  },
  "finalConfig": {
    "fileName": "<string>",
    "bpyMissingFilesReport": [
      "<string>"
    ],
    "blenderFileVersion": [
      123
    ],
    "blenderVersionForRender": "<string>",
    "missingFiles": [
      [
        "Image"
      ]
    ],
    "missingCaches": [
      {
        "type": "CLOTH",
        "sceneName": "<string>",
        "issueDescription": "<string>",
        "objectName": "<string>",
        "objectModifierName": "<string>"
      }
    ],
    "renderFrameRange": [
      123
    ],
    "resolution": [
      123
    ],
    "resolutionPercentage": 123,
    "fileSize": 123,
    "renderEngine": "CYCLES",
    "outputFormat": "PNG",
    "outputMediaType": "IMAGE",
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "fps": 123,
    "fpsBase": 123,
    "samples": 123,
    "useTiling": true,
    "tileSize": 123,
    "renderDevice": "GPU",
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "denoisingPrefilter": "<string>",
    "denoisingInputPasses": "<string>",
    "denoisingQuality": "<string>",
    "denoisingUseGpu": true,
    "denoisingDevice": "GPU",
    "persistentDataEnabled": true,
    "motionBlurEnabled": true,
    "compositionNodeTreeEnabled": true,
    "useCompositing": true,
    "haveOutputFileNode": true,
    "compositorHasRenderOutputNode": true,
    "pathToFileForRender": "<string>",
    "scenes": [
      {
        "name": "<string>",
        "is_active": true,
        "world": "<string>",
        "unit_settings": {
          "system": "<string>",
          "scale_length": 123
        },
        "gravity": [
          123
        ]
      }
    ],
    "animations": [
      {
        "name": "<string>",
        "frame_range": [
          123
        ],
        "fcurves": [
          {
            "data_path": "<string>",
            "index": 123
          }
        ]
      }
    ],
    "linkedData": [
      {
        "name": "<string>",
        "path": "<string>"
      }
    ],
    "addons": [
      "<string>"
    ],
    "cameras": [
      {
        "name": "<string>",
        "type": "<string>",
        "lens": 123,
        "clip_start": 123,
        "clip_end": 123,
        "sensor_width": 123,
        "sensor_height": 123,
        "shift_x": 123,
        "shift_y": 123,
        "dof": {
          "use_dof": true,
          "focus_distance": 123,
          "aperture_fstop": 123
        }
      }
    ],
    "renderLayersAndPasses": [
      {
        "name": "<string>",
        "use_pass_combined": true,
        "use_pass_z": true,
        "use_pass_normal": true
      }
    ],
    "colorManagementSettings": {
      "display_device": "<string>",
      "view_transform": "<string>",
      "look": "<string>",
      "exposure": 123,
      "gamma": 123
    },
    "lights": [
      {
        "name": "<string>",
        "type": "<string>",
        "color": [
          123
        ],
        "energy": 123,
        "shadow_soft_size": 123
      }
    ],
    "sceneCameras": [
      {
        "objectName": "<string>",
        "dataName": "<string>",
        "type": "<string>",
        "isSavedActive": true
      }
    ],
    "worldSettings": {
      "name": "<string>",
      "ambient_color": [
        123
      ],
      "mist_settings": {
        "use_mist": true,
        "start": 123,
        "depth": 123,
        "falloff": "<string>"
      }
    },
    "stereoscopySettings": [
      {
        "scene_name": "<string>",
        "use_multiview": true,
        "views_format": "<string>",
        "views_output": "<string>",
        "views": [
          {
            "name": "<string>",
            "use": true,
            "file_suffix": "<string>",
            "camera_suffix": "<string>"
          }
        ],
        "stereo_3d_format": {
          "display_mode": "<string>",
          "anaglyph_type": "<string>",
          "interlace_type": "<string>",
          "use_interlace_swap": true,
          "use_sidebyside_crosseyed": true
        }
      }
    ],
    "compositeOutputNodes": [
      {
        "name": "<string>",
        "label": "<string>",
        "base_path": "<string>",
        "format": "<string>",
        "media_type": "<string>",
        "slots": [
          {
            "name": "<string>",
            "path": "<string>"
          }
        ]
      }
    ],
    "frameStep": 123,
    "compositorDevice": "CPU",
    "viewLayers": [
      {
        "name": "<string>",
        "use": true,
        "isActive": true
      }
    ],
    "activeViewLayer": "<string>",
    "useSingleLayer": true,
    "vramMetadata": {
      "schemaVersion": 1,
      "sceneName": "<string>",
      "textures": {
        "imageCount": 1,
        "unknownSizeCount": 1,
        "packedImageCount": 1,
        "generatedImageCount": 1,
        "tiledImageCount": 1,
        "sequenceImageCount": 1,
        "movieImageCount": 1,
        "duplicateGroups": [
          {
            "key": "<string>",
            "count": 1,
            "names": [
              "<string>"
            ],
            "estimatedBytes": 123
          }
        ],
        "estimatedBytes": 123,
        "duplicateWasteBytes": 1
      },
      "geometry": {
        "objectCount": 1,
        "meshObjectCount": 1,
        "uniqueMeshCount": 1,
        "vertexCount": 1,
        "faceCount": 1,
        "triangleCount": 1,
        "estimatedBytes": 1
      },
      "riskFeatures": {
        "hasSubdivision": true,
        "hasMultires": true,
        "hasDisplacement": true,
        "hasGeometryNodes": true,
        "hasHairOrParticles": true,
        "hasVolumes": true
      },
      "renderOutput": {
        "viewLayerCount": 1,
        "passComponents": 1
      }
    },
    "analysisWarnings": [
      {
        "message": "<string>",
        "blocking": true,
        "code": "<string>"
      }
    ],
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "colorManagementPreset": "aces",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "videoOutput": true,
    "minimumRam": 1,
    "activeCamera": "<string>",
    "addonsToUse": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "bundledAddonPathsToUse": [
      "<string>"
    ],
    "expectedOutputs": {
      "schemaVersion": 1,
      "timelineFrames": 1,
      "viewMultiplier": 1,
      "views": [
        {
          "name": "<string>",
          "fileSuffix": "<string>",
          "cameraSuffix": "<string>"
        }
      ],
      "categories": [
        {
          "kind": "camera",
          "format": "<string>",
          "views": [
            {
              "name": "<string>",
              "fileSuffix": "<string>",
              "cameraSuffix": "<string>"
            }
          ],
          "expectedFileCount": 1,
          "nodeIndex": 1,
          "nodeName": "<string>",
          "nodeLabel": "<string>",
          "slotName": "<string>"
        }
      ],
      "totals": {
        "files": 1,
        "cameraFiles": 1,
        "compositeFiles": 1
      }
    },
    "sceneToRender": "<string>"
  },
  "output": {
    "isDeletedForClient": true,
    "scheduledForDeletionAt": "2023-11-07T05:31:56Z"
  },
  "isAnalysisSkipped": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "uploadPreflight": {
    "schemaVersion": 1,
    "source": "client_zip_inspection",
    "blendFiles": [
      "<string>"
    ],
    "packerManifestPreview": {
      "manifestPath": "<string>",
      "bundledAddons": [
        {
          "bundledPathInPack": "<string>",
          "selectedForBundle": true,
          "name": "<string>",
          "module": "<string>",
          "addonType": "<string>"
        }
      ]
    }
  },
  "analysis": {
    "id": "<string>",
    "fsNodeId": "<string>",
    "type": "scene_file",
    "status": "created",
    "config": {
      "pathToFileForRender": "<string>",
      "sceneToRender": "<string>",
      "addonsToUse": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "bundledAddonPathsToUse": [
        "<string>"
      ]
    },
    "output": {
      "fileName": "<string>",
      "bpyMissingFilesReport": [
        "<string>"
      ],
      "blenderFileVersion": [
        123
      ],
      "blenderVersionForRender": "<string>",
      "missingFiles": [
        [
          "Image"
        ]
      ],
      "missingCaches": [
        {
          "type": "CLOTH",
          "sceneName": "<string>",
          "issueDescription": "<string>",
          "objectName": "<string>",
          "objectModifierName": "<string>"
        }
      ],
      "renderFrameRange": [
        123
      ],
      "resolution": [
        123
      ],
      "resolutionPercentage": 123,
      "fileSize": 123,
      "renderEngine": "CYCLES",
      "outputFormat": "PNG",
      "outputMediaType": "IMAGE",
      "outputSettings": {
        "colorMode": "BW",
        "colorDepth": "8",
        "exrCodec": "NONE",
        "tiffCodec": "NONE",
        "compression": 123,
        "quality": 123
      },
      "fps": 123,
      "fpsBase": 123,
      "samples": 123,
      "useTiling": true,
      "tileSize": 123,
      "renderDevice": "GPU",
      "denoisingEnabled": true,
      "denoiserType": "OPTIX",
      "denoisingPrefilter": "<string>",
      "denoisingInputPasses": "<string>",
      "denoisingQuality": "<string>",
      "denoisingUseGpu": true,
      "denoisingDevice": "GPU",
      "persistentDataEnabled": true,
      "motionBlurEnabled": true,
      "compositionNodeTreeEnabled": true,
      "useCompositing": true,
      "haveOutputFileNode": true,
      "compositorHasRenderOutputNode": true,
      "pathToFileForRender": "<string>",
      "scenes": [
        {
          "name": "<string>",
          "is_active": true,
          "world": "<string>",
          "unit_settings": {
            "system": "<string>",
            "scale_length": 123
          },
          "gravity": [
            123
          ]
        }
      ],
      "animations": [
        {
          "name": "<string>",
          "frame_range": [
            123
          ],
          "fcurves": [
            {
              "data_path": "<string>",
              "index": 123
            }
          ]
        }
      ],
      "linkedData": [
        {
          "name": "<string>",
          "path": "<string>"
        }
      ],
      "addons": [
        "<string>"
      ],
      "cameras": [
        {
          "name": "<string>",
          "type": "<string>",
          "lens": 123,
          "clip_start": 123,
          "clip_end": 123,
          "sensor_width": 123,
          "sensor_height": 123,
          "shift_x": 123,
          "shift_y": 123,
          "dof": {
            "use_dof": true,
            "focus_distance": 123,
            "aperture_fstop": 123
          }
        }
      ],
      "renderLayersAndPasses": [
        {
          "name": "<string>",
          "use_pass_combined": true,
          "use_pass_z": true,
          "use_pass_normal": true
        }
      ],
      "colorManagementSettings": {
        "display_device": "<string>",
        "view_transform": "<string>",
        "look": "<string>",
        "exposure": 123,
        "gamma": 123
      },
      "lights": [
        {
          "name": "<string>",
          "type": "<string>",
          "color": [
            123
          ],
          "energy": 123,
          "shadow_soft_size": 123
        }
      ],
      "sceneCameras": [
        {
          "objectName": "<string>",
          "dataName": "<string>",
          "type": "<string>",
          "isSavedActive": true
        }
      ],
      "worldSettings": {
        "name": "<string>",
        "ambient_color": [
          123
        ],
        "mist_settings": {
          "use_mist": true,
          "start": 123,
          "depth": 123,
          "falloff": "<string>"
        }
      },
      "stereoscopySettings": [
        {
          "scene_name": "<string>",
          "use_multiview": true,
          "views_format": "<string>",
          "views_output": "<string>",
          "views": [
            {
              "name": "<string>",
              "use": true,
              "file_suffix": "<string>",
              "camera_suffix": "<string>"
            }
          ],
          "stereo_3d_format": {
            "display_mode": "<string>",
            "anaglyph_type": "<string>",
            "interlace_type": "<string>",
            "use_interlace_swap": true,
            "use_sidebyside_crosseyed": true
          }
        }
      ],
      "compositeOutputNodes": [
        {
          "name": "<string>",
          "label": "<string>",
          "base_path": "<string>",
          "format": "<string>",
          "media_type": "<string>",
          "slots": [
            {
              "name": "<string>",
              "path": "<string>"
            }
          ]
        }
      ],
      "frameStep": 123,
      "compositorDevice": "CPU",
      "viewLayers": [
        {
          "name": "<string>",
          "use": true,
          "isActive": true
        }
      ],
      "activeViewLayer": "<string>",
      "useSingleLayer": true,
      "vramMetadata": {
        "schemaVersion": 1,
        "sceneName": "<string>",
        "textures": {
          "imageCount": 1,
          "unknownSizeCount": 1,
          "packedImageCount": 1,
          "generatedImageCount": 1,
          "tiledImageCount": 1,
          "sequenceImageCount": 1,
          "movieImageCount": 1,
          "duplicateGroups": [
            {
              "key": "<string>",
              "count": 1,
              "names": [
                "<string>"
              ],
              "estimatedBytes": 123
            }
          ],
          "estimatedBytes": 123,
          "duplicateWasteBytes": 1
        },
        "geometry": {
          "objectCount": 1,
          "meshObjectCount": 1,
          "uniqueMeshCount": 1,
          "vertexCount": 1,
          "faceCount": 1,
          "triangleCount": 1,
          "estimatedBytes": 1
        },
        "riskFeatures": {
          "hasSubdivision": true,
          "hasMultires": true,
          "hasDisplacement": true,
          "hasGeometryNodes": true,
          "hasHairOrParticles": true,
          "hasVolumes": true
        },
        "renderOutput": {
          "viewLayerCount": 1,
          "passComponents": 1
        }
      },
      "analysisWarnings": [
        {
          "message": "<string>",
          "blocking": true,
          "code": "<string>"
        }
      ]
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "sceneFile": {
    "id": "<string>",
    "name": "<string>",
    "parentId": "<string>",
    "rootFolderId": "<string>",
    "isSceneFile": true,
    "size": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isDeleted": true,
    "isFolder": false,
    "scheduledForDeletionAt": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

POST

jobs

Create job

curl --request POST \
  --url https://api.renderjuice.com/api/external/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>"
}
'

import requests

url = "https://api.renderjuice.com/api/external/v1/jobs"

payload = { "slug": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({slug: '<string>'})
};

fetch('https://api.renderjuice.com/api/external/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "normalizedSeconds": 123,
  "previewUrl": "<string>",
  "failedReason": {
    "name": "<string>",
    "type": "VALIDATION_FAILED",
    "errorDetails": {}
  },
  "requestedConfig": {
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "blenderVersionForRender": "<string>",
    "colorManagementPreset": "aces",
    "renderEngine": "CYCLES",
    "compositorDevice": "CPU",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "denoisingUseGpu": true,
    "persistentDataEnabled": true,
    "resolution": [
      1
    ],
    "resolutionPercentage": 16384,
    "outputFormat": "PNG",
    "outputMediaType": "IMAGE",
    "fps": 16384,
    "fpsBase": 500000.000005,
    "videoOutput": true,
    "useTiling": true,
    "tileSize": 1,
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "minimumRam": 1,
    "activeCamera": "<string>",
    "activeViewLayer": "<string>"
  },
  "finalConfig": {
    "fileName": "<string>",
    "bpyMissingFilesReport": [
      "<string>"
    ],
    "blenderFileVersion": [
      123
    ],
    "blenderVersionForRender": "<string>",
    "missingFiles": [
      [
        "Image"
      ]
    ],
    "missingCaches": [
      {
        "type": "CLOTH",
        "sceneName": "<string>",
        "issueDescription": "<string>",
        "objectName": "<string>",
        "objectModifierName": "<string>"
      }
    ],
    "renderFrameRange": [
      123
    ],
    "resolution": [
      123
    ],
    "resolutionPercentage": 123,
    "fileSize": 123,
    "renderEngine": "CYCLES",
    "outputFormat": "PNG",
    "outputMediaType": "IMAGE",
    "outputSettings": {
      "colorMode": "BW",
      "colorDepth": "8",
      "exrCodec": "NONE",
      "tiffCodec": "NONE",
      "compression": 123,
      "quality": 123
    },
    "fps": 123,
    "fpsBase": 123,
    "samples": 123,
    "useTiling": true,
    "tileSize": 123,
    "renderDevice": "GPU",
    "denoisingEnabled": true,
    "denoiserType": "OPTIX",
    "denoisingPrefilter": "<string>",
    "denoisingInputPasses": "<string>",
    "denoisingQuality": "<string>",
    "denoisingUseGpu": true,
    "denoisingDevice": "GPU",
    "persistentDataEnabled": true,
    "motionBlurEnabled": true,
    "compositionNodeTreeEnabled": true,
    "useCompositing": true,
    "haveOutputFileNode": true,
    "compositorHasRenderOutputNode": true,
    "pathToFileForRender": "<string>",
    "scenes": [
      {
        "name": "<string>",
        "is_active": true,
        "world": "<string>",
        "unit_settings": {
          "system": "<string>",
          "scale_length": 123
        },
        "gravity": [
          123
        ]
      }
    ],
    "animations": [
      {
        "name": "<string>",
        "frame_range": [
          123
        ],
        "fcurves": [
          {
            "data_path": "<string>",
            "index": 123
          }
        ]
      }
    ],
    "linkedData": [
      {
        "name": "<string>",
        "path": "<string>"
      }
    ],
    "addons": [
      "<string>"
    ],
    "cameras": [
      {
        "name": "<string>",
        "type": "<string>",
        "lens": 123,
        "clip_start": 123,
        "clip_end": 123,
        "sensor_width": 123,
        "sensor_height": 123,
        "shift_x": 123,
        "shift_y": 123,
        "dof": {
          "use_dof": true,
          "focus_distance": 123,
          "aperture_fstop": 123
        }
      }
    ],
    "renderLayersAndPasses": [
      {
        "name": "<string>",
        "use_pass_combined": true,
        "use_pass_z": true,
        "use_pass_normal": true
      }
    ],
    "colorManagementSettings": {
      "display_device": "<string>",
      "view_transform": "<string>",
      "look": "<string>",
      "exposure": 123,
      "gamma": 123
    },
    "lights": [
      {
        "name": "<string>",
        "type": "<string>",
        "color": [
          123
        ],
        "energy": 123,
        "shadow_soft_size": 123
      }
    ],
    "sceneCameras": [
      {
        "objectName": "<string>",
        "dataName": "<string>",
        "type": "<string>",
        "isSavedActive": true
      }
    ],
    "worldSettings": {
      "name": "<string>",
      "ambient_color": [
        123
      ],
      "mist_settings": {
        "use_mist": true,
        "start": 123,
        "depth": 123,
        "falloff": "<string>"
      }
    },
    "stereoscopySettings": [
      {
        "scene_name": "<string>",
        "use_multiview": true,
        "views_format": "<string>",
        "views_output": "<string>",
        "views": [
          {
            "name": "<string>",
            "use": true,
            "file_suffix": "<string>",
            "camera_suffix": "<string>"
          }
        ],
        "stereo_3d_format": {
          "display_mode": "<string>",
          "anaglyph_type": "<string>",
          "interlace_type": "<string>",
          "use_interlace_swap": true,
          "use_sidebyside_crosseyed": true
        }
      }
    ],
    "compositeOutputNodes": [
      {
        "name": "<string>",
        "label": "<string>",
        "base_path": "<string>",
        "format": "<string>",
        "media_type": "<string>",
        "slots": [
          {
            "name": "<string>",
            "path": "<string>"
          }
        ]
      }
    ],
    "frameStep": 123,
    "compositorDevice": "CPU",
    "viewLayers": [
      {
        "name": "<string>",
        "use": true,
        "isActive": true
      }
    ],
    "activeViewLayer": "<string>",
    "useSingleLayer": true,
    "vramMetadata": {
      "schemaVersion": 1,
      "sceneName": "<string>",
      "textures": {
        "imageCount": 1,
        "unknownSizeCount": 1,
        "packedImageCount": 1,
        "generatedImageCount": 1,
        "tiledImageCount": 1,
        "sequenceImageCount": 1,
        "movieImageCount": 1,
        "duplicateGroups": [
          {
            "key": "<string>",
            "count": 1,
            "names": [
              "<string>"
            ],
            "estimatedBytes": 123
          }
        ],
        "estimatedBytes": 123,
        "duplicateWasteBytes": 1
      },
      "geometry": {
        "objectCount": 1,
        "meshObjectCount": 1,
        "uniqueMeshCount": 1,
        "vertexCount": 1,
        "faceCount": 1,
        "triangleCount": 1,
        "estimatedBytes": 1
      },
      "riskFeatures": {
        "hasSubdivision": true,
        "hasMultires": true,
        "hasDisplacement": true,
        "hasGeometryNodes": true,
        "hasHairOrParticles": true,
        "hasVolumes": true
      },
      "renderOutput": {
        "viewLayerCount": 1,
        "passComponents": 1
      }
    },
    "analysisWarnings": [
      {
        "message": "<string>",
        "blocking": true,
        "code": "<string>"
      }
    ],
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "colorManagementPreset": "aces",
    "computeDeviceType": "CUDA",
    "gpuCount": 1,
    "sampleCount": 1,
    "videoOutput": true,
    "minimumRam": 1,
    "activeCamera": "<string>",
    "addonsToUse": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "bundledAddonPathsToUse": [
      "<string>"
    ],
    "expectedOutputs": {
      "schemaVersion": 1,
      "timelineFrames": 1,
      "viewMultiplier": 1,
      "views": [
        {
          "name": "<string>",
          "fileSuffix": "<string>",
          "cameraSuffix": "<string>"
        }
      ],
      "categories": [
        {
          "kind": "camera",
          "format": "<string>",
          "views": [
            {
              "name": "<string>",
              "fileSuffix": "<string>",
              "cameraSuffix": "<string>"
            }
          ],
          "expectedFileCount": 1,
          "nodeIndex": 1,
          "nodeName": "<string>",
          "nodeLabel": "<string>",
          "slotName": "<string>"
        }
      ],
      "totals": {
        "files": 1,
        "cameraFiles": 1,
        "compositeFiles": 1
      }
    },
    "sceneToRender": "<string>"
  },
  "output": {
    "isDeletedForClient": true,
    "scheduledForDeletionAt": "2023-11-07T05:31:56Z"
  },
  "isAnalysisSkipped": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "uploadPreflight": {
    "schemaVersion": 1,
    "source": "client_zip_inspection",
    "blendFiles": [
      "<string>"
    ],
    "packerManifestPreview": {
      "manifestPath": "<string>",
      "bundledAddons": [
        {
          "bundledPathInPack": "<string>",
          "selectedForBundle": true,
          "name": "<string>",
          "module": "<string>",
          "addonType": "<string>"
        }
      ]
    }
  },
  "analysis": {
    "id": "<string>",
    "fsNodeId": "<string>",
    "type": "scene_file",
    "status": "created",
    "config": {
      "pathToFileForRender": "<string>",
      "sceneToRender": "<string>",
      "addonsToUse": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "bundledAddonPathsToUse": [
        "<string>"
      ]
    },
    "output": {
      "fileName": "<string>",
      "bpyMissingFilesReport": [
        "<string>"
      ],
      "blenderFileVersion": [
        123
      ],
      "blenderVersionForRender": "<string>",
      "missingFiles": [
        [
          "Image"
        ]
      ],
      "missingCaches": [
        {
          "type": "CLOTH",
          "sceneName": "<string>",
          "issueDescription": "<string>",
          "objectName": "<string>",
          "objectModifierName": "<string>"
        }
      ],
      "renderFrameRange": [
        123
      ],
      "resolution": [
        123
      ],
      "resolutionPercentage": 123,
      "fileSize": 123,
      "renderEngine": "CYCLES",
      "outputFormat": "PNG",
      "outputMediaType": "IMAGE",
      "outputSettings": {
        "colorMode": "BW",
        "colorDepth": "8",
        "exrCodec": "NONE",
        "tiffCodec": "NONE",
        "compression": 123,
        "quality": 123
      },
      "fps": 123,
      "fpsBase": 123,
      "samples": 123,
      "useTiling": true,
      "tileSize": 123,
      "renderDevice": "GPU",
      "denoisingEnabled": true,
      "denoiserType": "OPTIX",
      "denoisingPrefilter": "<string>",
      "denoisingInputPasses": "<string>",
      "denoisingQuality": "<string>",
      "denoisingUseGpu": true,
      "denoisingDevice": "GPU",
      "persistentDataEnabled": true,
      "motionBlurEnabled": true,
      "compositionNodeTreeEnabled": true,
      "useCompositing": true,
      "haveOutputFileNode": true,
      "compositorHasRenderOutputNode": true,
      "pathToFileForRender": "<string>",
      "scenes": [
        {
          "name": "<string>",
          "is_active": true,
          "world": "<string>",
          "unit_settings": {
            "system": "<string>",
            "scale_length": 123
          },
          "gravity": [
            123
          ]
        }
      ],
      "animations": [
        {
          "name": "<string>",
          "frame_range": [
            123
          ],
          "fcurves": [
            {
              "data_path": "<string>",
              "index": 123
            }
          ]
        }
      ],
      "linkedData": [
        {
          "name": "<string>",
          "path": "<string>"
        }
      ],
      "addons": [
        "<string>"
      ],
      "cameras": [
        {
          "name": "<string>",
          "type": "<string>",
          "lens": 123,
          "clip_start": 123,
          "clip_end": 123,
          "sensor_width": 123,
          "sensor_height": 123,
          "shift_x": 123,
          "shift_y": 123,
          "dof": {
            "use_dof": true,
            "focus_distance": 123,
            "aperture_fstop": 123
          }
        }
      ],
      "renderLayersAndPasses": [
        {
          "name": "<string>",
          "use_pass_combined": true,
          "use_pass_z": true,
          "use_pass_normal": true
        }
      ],
      "colorManagementSettings": {
        "display_device": "<string>",
        "view_transform": "<string>",
        "look": "<string>",
        "exposure": 123,
        "gamma": 123
      },
      "lights": [
        {
          "name": "<string>",
          "type": "<string>",
          "color": [
            123
          ],
          "energy": 123,
          "shadow_soft_size": 123
        }
      ],
      "sceneCameras": [
        {
          "objectName": "<string>",
          "dataName": "<string>",
          "type": "<string>",
          "isSavedActive": true
        }
      ],
      "worldSettings": {
        "name": "<string>",
        "ambient_color": [
          123
        ],
        "mist_settings": {
          "use_mist": true,
          "start": 123,
          "depth": 123,
          "falloff": "<string>"
        }
      },
      "stereoscopySettings": [
        {
          "scene_name": "<string>",
          "use_multiview": true,
          "views_format": "<string>",
          "views_output": "<string>",
          "views": [
            {
              "name": "<string>",
              "use": true,
              "file_suffix": "<string>",
              "camera_suffix": "<string>"
            }
          ],
          "stereo_3d_format": {
            "display_mode": "<string>",
            "anaglyph_type": "<string>",
            "interlace_type": "<string>",
            "use_interlace_swap": true,
            "use_sidebyside_crosseyed": true
          }
        }
      ],
      "compositeOutputNodes": [
        {
          "name": "<string>",
          "label": "<string>",
          "base_path": "<string>",
          "format": "<string>",
          "media_type": "<string>",
          "slots": [
            {
              "name": "<string>",
              "path": "<string>"
            }
          ]
        }
      ],
      "frameStep": 123,
      "compositorDevice": "CPU",
      "viewLayers": [
        {
          "name": "<string>",
          "use": true,
          "isActive": true
        }
      ],
      "activeViewLayer": "<string>",
      "useSingleLayer": true,
      "vramMetadata": {
        "schemaVersion": 1,
        "sceneName": "<string>",
        "textures": {
          "imageCount": 1,
          "unknownSizeCount": 1,
          "packedImageCount": 1,
          "generatedImageCount": 1,
          "tiledImageCount": 1,
          "sequenceImageCount": 1,
          "movieImageCount": 1,
          "duplicateGroups": [
            {
              "key": "<string>",
              "count": 1,
              "names": [
                "<string>"
              ],
              "estimatedBytes": 123
            }
          ],
          "estimatedBytes": 123,
          "duplicateWasteBytes": 1
        },
        "geometry": {
          "objectCount": 1,
          "meshObjectCount": 1,
          "uniqueMeshCount": 1,
          "vertexCount": 1,
          "faceCount": 1,
          "triangleCount": 1,
          "estimatedBytes": 1
        },
        "riskFeatures": {
          "hasSubdivision": true,
          "hasMultires": true,
          "hasDisplacement": true,
          "hasGeometryNodes": true,
          "hasHairOrParticles": true,
          "hasVolumes": true
        },
        "renderOutput": {
          "viewLayerCount": 1,
          "passComponents": 1
        }
      },
      "analysisWarnings": [
        {
          "message": "<string>",
          "blocking": true,
          "code": "<string>"
        }
      ]
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "sceneFile": {
    "id": "<string>",
    "name": "<string>",
    "parentId": "<string>",
    "rootFolderId": "<string>",
    "isSceneFile": true,
    "size": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isDeleted": true,
    "isFolder": false,
    "scheduledForDeletionAt": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "details": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ],
  "type": "zod",
  "metadata": {}
}

This is step 3 of the upload and render workflow. Call this endpoint after the presigned PUT from POST /uploads returns a 2xx response. Send the upload slug in this request, then use the returned job id for validation, rendering, status, and downloads.

Authorizations

Authorization

string

header

required

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

Body

application/json

slug

string

required

Upload slug returned by the external upload endpoint. Use this to create the job after the file upload completes.

Minimum string length: 1

Response

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,

debugging,

rendering,

finalizing,

completed,

failed,

canceled,

booting,

suspended

Example:

"completed"

userId

string<uuid>

required

Identifier of the user who created the job.

workspaceId

string<uuid>

required

Identifier of the workspace that owns the job.

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

analysisId

string<uuid> | null

Opaque identifier of the associated analysis.

rootFolderId

string<uuid> | null

Identifier of the job input root folder.

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 | null

Failure information intended for the client.

Show child attributes

requestedConfig

Override configuration that was requested for this job

Show child attributes

finalConfig

object | null

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

Show child attributes

output

object

Information about the job output files

Show child attributes

isAnalysisSkipped

boolean

Whether scene file analysis was skipped for this job

projectId

string<uuid> | null

Project containing the job, when assigned.

uploadPreflight

object | null

Client-side ZIP inspection data captured before upload.

Show child attributes

analysis

object | null

Client-visible validation state and scene metadata.

Show child attributes

sceneFile

object

Client-visible scene file metadata.

Show child attributes

{key}

unknown

Overview

Endpoint Reference

Webhook Reference

Authorizations

Body

Response