Skip to main content
POST
/
v1
/
video
/
remove-background
/
job
/
{jobId}
/
cancel
Cancel Video Remove Background Job
curl --request POST \
  --url https://api.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)
const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/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.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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 := "https://api.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel"

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

	req.Header.Add("X-API-KEY", "<api-key>")

	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.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.developer.pixelcut.ai/v1/video/remove-background/job/{jobId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "message": "Job cancelled"
}
{
  "error": "API Token not found",
  "error_code": "invalid_auth_token"
}
{
  "error": "Job not found",
  "error_code": "not_found"
}
{
  "error": "Job has already finished and cannot be canceled",
  "error_code": "job_finished"
}
{
  "error": "Too many requests",
  "error_code": "rate_limit_exceeded"
}

Authorizations

X-API-KEY
string
header
required

All API requests require a valid api key. Include your token as a HTTP request header in the following format: X-API-Key: skXXXXXXXXXXXXXXXX. You can obtain an api key by signing up for developer access in your Pixelcut account.

Path Parameters

jobId
string
required

The ID of the job to cancel

Response

Job cancelled successfully

message
string

Confirmation message

Example:

"Job cancelled"