Cancel multiple jobs

curl --request POST \
  --url https://api.nexrender.com/api/v2/jobs/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    "<string>"
  ]
}
'

import requests

url = "https://api.nexrender.com/api/v2/jobs/cancel"

payload = { "jobs": ["<string>"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({jobs: ['<string>']})
};

fetch('https://api.nexrender.com/api/v2/jobs/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nexrender.com/api/v2/jobs/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jobs' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nexrender.com/api/v2/jobs/cancel"

	payload := strings.NewReader("{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nexrender.com/api/v2/jobs/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nexrender.com/api/v2/jobs/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "templateId": "<string>",
    "status": "<string>",
    "progress": 123,
    "stats": {
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "errorAt": "2023-11-07T05:31:56Z",
      "totalAssets": 123,
      "renderDuration": 123,
      "error": "<string>"
    },
    "outputUrl": "<string>"
  }
]

{
  "error": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

jobs

cancel

Cancel multiple jobs

curl --request POST \
  --url https://api.nexrender.com/api/v2/jobs/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    "<string>"
  ]
}
'

import requests

url = "https://api.nexrender.com/api/v2/jobs/cancel"

payload = { "jobs": ["<string>"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({jobs: ['<string>']})
};

fetch('https://api.nexrender.com/api/v2/jobs/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nexrender.com/api/v2/jobs/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jobs' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nexrender.com/api/v2/jobs/cancel"

	payload := strings.NewReader("{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nexrender.com/api/v2/jobs/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nexrender.com/api/v2/jobs/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jobs\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "templateId": "<string>",
    "status": "<string>",
    "progress": 123,
    "stats": {
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "errorAt": "2023-11-07T05:31:56Z",
      "totalAssets": 123,
      "renderDuration": 123,
      "error": "<string>"
    },
    "outputUrl": "<string>"
  }
]

{
  "error": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication using API tokens for team-based access control.

You can generate your own API token at: https://app.nexrender.com/settings/api-tokens

Body

application/json

Request payload for cancelling one or more jobs by ID.

jobs

string[]

required

List of job IDs to cancel. Each explicitly requested job must be in a cancellable state.

Required array length: 1 - 1000 elements

Unique job identifier in ULID format

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Successfully cancelled the requested job set and any related jobs that were also cancellable.

string

Unique job identifier used for tracking and API operations

templateId

string | null

Reference to the template used for this job (null if template was not used)

status

string

Current job status (queued, render:dorender, finished, error, etc.). Manually cancelled jobs are normalized to manually_cancelled in v2 responses even though they are stored internally as error.

progress

number<float>

Render progress as a percentage (0.0 to 100.0)

stats

object

Detailed timing and metadata statistics for the job

Show child attributes

outputUrl

string | null

URL to the rendered content

Templates Management

Rendering Jobs

Batch Jobs

Fonts Management

Secrets Management

Team

Authorizations

Body

Response