Create

POST

jobs

curl --request POST \
  --url http://localhost:44442/api/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "3dsmax.render",
  "name": "Lobby stills",
  "file": "//NAS/projects/tower/scenes/lobby_v012.max",
  "host": {
    "id": "3dsmax",
    "version": "2026"
  },
  "engine": {
    "id": "vray",
    "name": "V-Ray",
    "version": "7.1"
  },
  "camera": "Cam_Lobby_01",
  "frame": "0",
  "resolution": "4000x2250",
  "output": [
    {
      "enabled": true,
      "type": 0,
      "path": "//NAS/projects/tower/renders/lobby/lobby_.exr"
    }
  ]
}
'

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

An API key from Settings, API Keys. A caller on this machine needs none.

Query Parameters

wait

boolean

default:false

Block until the job is built and answer 201, instead of 202 with one that is still being prepared

Body

application/json

name

string

required

Required string length: 1 - 255

steps

object[]

required

Minimum array length: 1

Show child attributes

user_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

icon

string | null

description

string

default:""

thumbnail

string | null

color

string | null

Response

The created job, staged and queueable. Only with wait=true

string

required

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

name

string

default:""

required

status

enum<string>

required

Available options:

working,

finishing,

pending,

preparing,

submitting,

failed,

archived,

suspended,

scheduled,

queued,

completed,

disabled,

unknown

description

string

default:""

required

tags

string[]

required

priority

number

default:50

required

steps

object[]

required

Show child attributes

dependencies

object[]

required

Show child attributes

metadata

object[]

required

Show child attributes

notifications

object[]

required

Show child attributes

cleanup

object

required

Show child attributes

assets

object[]

required

Show child attributes

progress

object

required

Show child attributes

user_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

api_key_id

string | null

The API key that submitted it

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

pool_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

group_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

storage_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

icon

string | null

thumbnail

string | null

color

string | null

env

object

Environment variables for every application the job starts, over the app's own. $NAME reads the value the app would have had.

Show child attributes

Example:

{
  "OCIO": "//studio/config/aces.ocio",
  "PATH": "$PATH;//studio/tools/bin"
}

errors

object[]

Show child attributes

schedule_date

integer | null

Example:

1785846207000

created_at

integer | null

Example:

1785846207000

started_at

integer | null

Example:

1785846207000

finished_at

integer | null

Example:

1785846207000

archived_at

integer | null

Example:

1785846207000

removed_at

integer | null

Example:

1785846207000

curl --request POST \
  --url http://localhost:44442/api/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "3dsmax.render",
  "name": "Lobby stills",
  "file": "//NAS/projects/tower/scenes/lobby_v012.max",
  "host": {
    "id": "3dsmax",
    "version": "2026"
  },
  "engine": {
    "id": "vray",
    "name": "V-Ray",
    "version": "7.1"
  },
  "camera": "Cam_Lobby_01",
  "frame": "0",
  "resolution": "4000x2250",
  "output": [
    {
      "enabled": true,
      "type": 0,
      "path": "//NAS/projects/tower/renders/lobby/lobby_.exr"
    }
  ]
}
'

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Overview

Getting Started

Guides

Scripting

Developers

API Reference

Support

Resources

Authorizations

Query Parameters

Body

Response