Retrieve a task

GET

openapi

tasks

task-info

Retrieve a task

curl --request GET \
  --url https://api.neural4d.com/openapi/v1/tasks/task-info \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.neural4d.com/openapi/v1/tasks/task-info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

fetch('https://api.neural4d.com/openapi/v1/tasks/task-info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.neural4d.com/openapi/v1/tasks/task-info"

	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("https://api.neural4d.com/openapi/v1/tasks/task-info")

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neural4d.com/openapi/v1/tasks/task-info",
  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;
}

using RestSharp;


var options = new RestClientOptions("https://api.neural4d.com/openapi/v1/tasks/task-info");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "normal-video-c50fe63e-699d-4d61-93f5-2099ab159d6d",
  "status": "succeeded",
  "mode": "first_frame_image_to_video",
  "model": "bytedance/seedance-2.0-fast",
  "created_at": 1784044800,
  "updated_at": 1784044842,
  "usage": {
    "credits": 26
  },
  "output": {
    "videos": [
      {
        "uuid": "7d1fa4bb-41e6-4a5d-88d8-1851f5342e87",
        "url": "https://cdn.neural4d.com/results/video.mp4",
        "format": "mp4",
        "duration": 5,
        "resolution": "720p",
        "aspect_ratio": "16:9",
        "has_audio": true,
        "mode": "first_frame_image_to_video",
        "status": "succeeded",
        "created_at": 1784044800,
        "updated_at": 1784044842
      }
    ]
  }
}

Authorizations

Authorization

string

header

default:${YOUR_API_KEY}

required

Neural4D API key using the Bearer scheme.

Query Parameters

string

Batch task ID returned by a generation request. Provide this or uuid, but not both.

Example:

"normal-video-c50fe63e-699d-4d61-93f5-2099ab159d6d"

uuid

string<uuid>

Child video UUID returned in the generation response. Provide this or id, but not both.

Example:

"7d1fa4bb-41e6-4a5d-88d8-1851f5342e87"

Response

Task details

string

required

Batch task ID returned by a generation request.

Example:

"normal-video-c50fe63e-699d-4d61-93f5-2099ab159d6d"

status

enum<string>

required

Normalized task lifecycle status.

Available options:

queued,

processing,

succeeded,

failed

created_at

integer<int64>

required

Unix timestamp in seconds.

output

object

required

Current child video task output, including entries that are still queued or processing.

Show child attributes

mode

enum<string>

required

Video generation mode used by the task.

Available options:

text_to_video,

first_frame_image_to_video,

first_last_frame_image_to_video,

reference_to_video

model

enum<string> | null

Video generation model used by the task.

Available options:

bytedance/seedance-2.0,

bytedance/seedance-2.0-fast,

google/veo-3.1,

xai/grok-imagine

updated_at

integer<int64>

Unix timestamp in seconds.

usage

object

Credits charged for this task when available.

Show child attributes

error

object

Error details when the task fails.

Show child attributes

Retrieve a task

curl --request GET \
  --url https://api.neural4d.com/openapi/v1/tasks/task-info \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.neural4d.com/openapi/v1/tasks/task-info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

fetch('https://api.neural4d.com/openapi/v1/tasks/task-info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.neural4d.com/openapi/v1/tasks/task-info"

	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("https://api.neural4d.com/openapi/v1/tasks/task-info")

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neural4d.com/openapi/v1/tasks/task-info",
  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;
}

using RestSharp;


var options = new RestClientOptions("https://api.neural4d.com/openapi/v1/tasks/task-info");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "normal-video-c50fe63e-699d-4d61-93f5-2099ab159d6d",
  "status": "succeeded",
  "mode": "first_frame_image_to_video",
  "model": "bytedance/seedance-2.0-fast",
  "created_at": 1784044800,
  "updated_at": 1784044842,
  "usage": {
    "credits": 26
  },
  "output": {
    "videos": [
      {
        "uuid": "7d1fa4bb-41e6-4a5d-88d8-1851f5342e87",
        "url": "https://cdn.neural4d.com/results/video.mp4",
        "format": "mp4",
        "duration": 5,
        "resolution": "720p",
        "aspect_ratio": "16:9",
        "has_audio": true,
        "mode": "first_frame_image_to_video",
        "status": "succeeded",
        "created_at": 1784044800,
        "updated_at": 1784044842
      }
    ]
  }
}

Get started

API reference

Authorizations

Query Parameters

Response