Skip to main content
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": {
    "frameRanges": [
      "<string>"
    ],
    "notes": "<string>",
    "gpuCount": 1,
    "sampleCount": 1,
    "denoisingEnabled": true,
    "resolution": [
      1
    ],
    "resolutionPercentage": 16384,
    "fps": 1,
    "videoOutput": true,
    "useTiling": true,
    "tileSize": 1,
    "outputSettings": {
      "compression": 123,
      "quality": 123
    },
    "minimumRam": 1,
    "activeCamera": "<string>",
    "activeViewLayer": "<string>"
  }
}
'
{
  "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

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

​
Idempotency

This endpoint is idempotent for duplicate start requests. If a render was already started for the job, the API returns 200 OK with the current job payload and sets header X-Idempotent-Replay: true.
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

​
id
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.

Response

200 - application/json

Success

​
id
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"

​
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

​
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

​
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