Skip to main content
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>"
}
'
{
  "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>"
}

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

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