Retrieve

GET

tasks

{id}

Retrieve

curl --request GET \
  --url http://localhost:44442/api/v1/tasks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/tasks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/tasks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:44442/api/v1/tasks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/tasks/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "index": 123,
  "job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "type": "renderflow.test",
  "status": "working",
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "props": [],
  "result": null,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "attempt": 0,
  "helper": true,
  "pin": "68b1f0c2a4d3e5f6a7b8c9d0",
  "thumbnail": {
    "path": "",
    "updated_at": 1785846207000,
    "kind": "preview",
    "preview_path": "<string>",
    "width": 123,
    "height": 123
  },
  "outputs": [
    {
      "key": "<string>",
      "path": "<string>",
      "source": "observed",
      "frame": 123,
      "element": "<string>",
      "size": 1,
      "width": 2,
      "height": 2,
      "written_at": 1785846207000,
      "mismatch": {
        "expected": "<string>"
      }
    }
  ],
  "licenses": [
    "<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.

Path Parameters

string

required

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

The task

string

required

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

index

integer

required

job_id

string

required

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

step_id

string

required

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

node_id

string | null

required

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

type

enum<string>

required

Available options:

renderflow.test,

3dsmax.render,

3dsmax.scene_manager.render,

arnold.render,

after.render,

blender.render,

cinema4d.render,

houdini.batch,

houdini.mantra,

houdini.husk,

imager,

ffmpeg,

denoise,

autograph.render,

fusion.render,

harmony.render,

keyshot.render,

maya.render,

nuke.render,

renderman.render,

premiere.render,

media_encoder.encode,

davinci.render,

shell,

python,

unreal,

vray.dr.spawner,

redshift.render,

sketchup.render,

rhino.render,

vray_standalone,

vantage.render,

vred.render,

comfyui.render,

agentic,

3dsmax.script,

blender.script,

cinema4d.script,

maya.script,

houdini.script,

nuke.script,

fusion.script,

3dsmax.export,

maya.export,

blender.export,

cinema4d.export,

renderflow.custom_plugin,

renderflow.benchmark

status

enum<string>

required

Available options:

working,

finishing,

pending,

preparing,

submitting,

failed,

archived,

suspended,

scheduled,

queued,

completed,

disabled,

unknown

progress

object

required

Show child attributes

props

object[]

required

Show child attributes

result

object | null

required

Show child attributes

started_at

integer | null

required

Example:

1785846207000

finished_at

integer | null

required

Example:

1785846207000

attempt

integer

default:0

required

Required range: x >= 0

helper

boolean

required

string | null

The machine an operator pinned this task to; it is only ever rendered there

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

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

thumbnail

object | null

Show child attributes

outputs

object[]

Show child attributes

licenses

string[]

Retrieve

curl --request GET \
  --url http://localhost:44442/api/v1/tasks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/tasks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/tasks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:44442/api/v1/tasks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/tasks/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "index": 123,
  "job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "type": "renderflow.test",
  "status": "working",
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "props": [],
  "result": null,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "attempt": 0,
  "helper": true,
  "pin": "68b1f0c2a4d3e5f6a7b8c9d0",
  "thumbnail": {
    "path": "",
    "updated_at": 1785846207000,
    "kind": "preview",
    "preview_path": "<string>",
    "width": 123,
    "height": 123
  },
  "outputs": [
    {
      "key": "<string>",
      "path": "<string>",
      "source": "observed",
      "frame": 123,
      "element": "<string>",
      "size": 1,
      "width": 2,
      "height": 2,
      "written_at": 1785846207000,
      "mismatch": {
        "expected": "<string>"
      }
    }
  ],
  "licenses": [
    "<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

Path Parameters

Response