Get job

Get job

curl --request GET \
  --url https://api.renderjuice.com/api/external/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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>"
  }
}

GET

jobs

{id}

Get job

curl --request GET \
  --url https://api.renderjuice.com/api/external/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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.

Path Parameters

string<uuid>

required

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

Example:

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

Response

200 - application/json

Success

data

object

required

Show child attributes

data.id

string<uuid>

required

Unique identifier of the job

Example:

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

data.status

enum<string>

required

Current status of the job

Available options:

created,

validating,

validated,

rendering,

finalizing,

completed,

failed,

canceled,

booting,

suspended

Example:

"completed"

data.workspaceId

string<uuid>

required

ID of the workspace this job belongs to

data.createdAt

string<date-time>

required

ISO 8601 timestamp when the job was created

data.updatedAt

string<date-time>

required

ISO 8601 timestamp when the job was last updated

data.userId

string<uuid>

ID of the user who created the job

data.rootFolderId

string<uuid> | null

ID of the root folder containing the job files

data.normalizedSeconds

number

Normalized rendering time in seconds (adjusted for GPU performance)

data.previewUrl

string<uri> | null

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

data.failedReason

object

Details about why the job failed, if applicable

Show child attributes

data.failedReason.name

string

required

Name of the error that caused the failure

data.failedReason.type

string

required

Type or category of the error

data.requestedConfig

any | null

Override configuration that was requested for this job

data.finalConfig

any | null

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

data.output

object

Information about the job output files

Show child attributes

data.output.isDeletedForClient

boolean

required

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

data.isAnalysisSkipped

boolean

Whether scene file analysis was skipped for this job

data.analysisId

string<uuid> | null

ID of the analysis associated with this job

data.analysis

any | null

Analysis results for the scene file

data.sceneFile

any | null

Information about the scene file used for rendering

Get job progress

Start validation

⌘I

Overview

API

Webhooks

Authorizations

Path Parameters

Response