Remove Background

Remove Background

curl --request POST \
  --url https://api.hooked.so/v1/project/create/remove-background \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "media": "video_01"
}
'

import requests

url = "https://api.hooked.so/v1/project/create/remove-background"

payload = { "media": "video_01" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({media: 'video_01'})
};

fetch('https://api.hooked.so/v1/project/create/remove-background', 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.hooked.so/v1/project/create/remove-background",
  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([
    'media' => 'video_01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hooked.so/v1/project/create/remove-background"

	payload := strings.NewReader("{\n  \"media\": \"video_01\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.hooked.so/v1/project/create/remove-background")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"media\": \"video_01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hooked.so/v1/project/create/remove-background")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"media\": \"video_01\"\n}"

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

{
  "success": true,
  "data": {
    "videoId": "vid_rbg_abc123xyz",
    "projectId": "proj_rbg_abc123xyz",
    "status": "STARTED"
  },
  "message": "Remove Background successfully created"
}

{
  "success": false,
  "message": "media: Video is required"
}

{
  "success": false,
  "message": "media: Media must be a video file"
}

POST

project

create

remove-background

Remove Background

curl --request POST \
  --url https://api.hooked.so/v1/project/create/remove-background \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "media": "video_01"
}
'

import requests

url = "https://api.hooked.so/v1/project/create/remove-background"

payload = { "media": "video_01" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({media: 'video_01'})
};

fetch('https://api.hooked.so/v1/project/create/remove-background', 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.hooked.so/v1/project/create/remove-background",
  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([
    'media' => 'video_01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hooked.so/v1/project/create/remove-background"

	payload := strings.NewReader("{\n  \"media\": \"video_01\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.hooked.so/v1/project/create/remove-background")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"media\": \"video_01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hooked.so/v1/project/create/remove-background")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"media\": \"video_01\"\n}"

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

{
  "success": true,
  "data": {
    "videoId": "vid_rbg_abc123xyz",
    "projectId": "proj_rbg_abc123xyz",
    "status": "STARTED"
  },
  "message": "Remove Background successfully created"
}

{
  "success": false,
  "message": "media: Video is required"
}

{
  "success": false,
  "message": "media: Media must be a video file"
}

Try it out! Use the API playground on the right to test the Remove Background endpoint directly.

Overview

Remove Background automatically removes the background from your videos, creating a transparent background effect. Perfect for:

Product videos
Talking head videos
Social media content
Professional presentations
Green screen replacements

The API processes your video and returns a clean version with the background removed, ready to overlay on any content.

Endpoint

POST /v1/project/create/remove-background

Required Fields

string

required

Media ID of the video to process. The video must already be uploaded to your account.

Request Example

const response = await fetch('https://api.hooked.so/v1/project/create/remove-background', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.HOOKED_API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    media: 'video_01',
    webhook: 'https://yoursite.com/webhook',
    metadata: {
      campaignId: 'summer-launch-2024',
      variant: 'A',
      createdBy: 'marketing-automation'
    }
  })
});

const data = await response.json();
console.log('Video ID:', data.data.videoId);
console.log('Project ID:', data.data.projectId);

Response

{
  "success": true,
  "data": {
    "videoId": "vid_rbg_abc123xyz",
    "projectId": "proj_rbg_abc123xyz",
    "status": "STARTED"
  },
  "message": "Remove Background successfully created"
}

{
  "success": false,
  "message": "media: Video is required"
}

{
  "success": false,
  "message": "media: Media must be a video file"
}

Webhook Notification

When your video is ready, we’ll POST to your webhook URL (if configured):

Webhook Payload

{
  "status": "COMPLETED",
  "data": {
    "videoId": "vid_rbg_abc123xyz",
    "status": "COMPLETED",
    "url": "https://cdn.hooked.so/videos/abc123xyz.mp4",
    "shareUrl": "https://cdn.hooked.so/shared/abc123xyz.mp4",
    "metadata": {
      "projectId": "proj_rbg_abc123xyz"
    }
  },
  "message": "Video completed"
}

Best Practices

Video Quality

Use high-quality source videos for best background removal results.

Good Lighting

Videos with good lighting and clear subject separation work best.

Avoid Motion Blur

Sharper videos work better for background removal.

Clear Separation

Ensure good contrast between subject and background.

Error Handling

Error	Description	Solution
`media: Video is required`	Missing media ID	Provide a media ID string
`media: Video not found`	Media ID doesn’t exist in your account	Ensure the media ID is correct and belongs to your team
`media: Media must be a video file`	Media is not a video type	Provide a video media ID, not an image media ID
`Not enough credits`	Insufficient credits	Top up your account credits

Next Steps

List Videos

View all your created videos

Video Details

Check your video processing status

Webhooks Guide

Learn how to handle webhook notifications

Talking Avatar

Create talking avatar videos with AI avatars

Authorizations

x-api-key

string

header

required

Body

application/json

media

string

required

Media ID of the video to process. The video must already be uploaded to your account.

Response

Remove Background created successfully

success

boolean

data

object

Show child attributes

message

string

Getting Started

Resources

Videos

Templates

Trends

Niches

Social Accounts

Social Search

Scheduling

Overview

Endpoint

Required Fields

Request Example

Response

Webhook Notification

Best Practices

Video Quality

Good Lighting

Avoid Motion Blur

Clear Separation

Error Handling

Next Steps

List Videos

Video Details

Webhooks Guide

Talking Avatar

Authorizations

Body

Response

​Overview

​Endpoint

​Required Fields

​Request Example

​Response

​Webhook Notification

​Best Practices

Video Quality

Good Lighting

Avoid Motion Blur

Clear Separation

​Error Handling

​Next Steps

List Videos

Video Details

Webhooks Guide

Talking Avatar

Authorizations

Body

Response

Overview

Endpoint

Required Fields

Request Example

Response

Webhook Notification

Best Practices

Error Handling

Next Steps