Video Remove Background

Request

Header Params

x-api-key

string

required

Your API Key for authorization

Body Params application/json

model

enum<string>

required

Allowed value:

Qubico/video-toolkit

task_type

enum<string>

required

Allowed value:

background-remove

input

object

required

video

string

required

Video URL or base64 string (MP4 format only)

invert_output

boolean

optional

Invert the output image/mask if true.

Default:

false

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

Example

{
    "model": "Qubico/video-toolkit",
    "task_type": "background-remove",
    "input": {
        "video": "https://storage.theapi.app/images/playground/20250725/bf82h5de80b.mp4",
        "invert_output": false
    },
    "config": {
        "webhook_config": {
            "endpoint": "https://webhook.site/8ed66cc5-8c97-4926-a452-08aed4b450a5",
            "secret": ""
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "Qubico/video-toolkit",
    "task_type": "background-remove",
    "input": {
        "video": "https://storage.theapi.app/images/playground/20250725/bf82h5de80b.mp4",
        "invert_output": false
    },
    "config": {
        "webhook_config": {
            "endpoint": "https://webhook.site/8ed66cc5-8c97-4926-a452-08aed4b450a5",
            "secret": ""
        }
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

task_type

string

required

status

string

required

task_info

object

required

task_result

object

required

message

string

required

Example

{
    "code": 200,
    "data": {
        "task_id": "ef501094-2039-402d-95cb-2e43af39fa03",
        "model": "Qubico/video-toolkit",
        "task_type": "background-remove",
        "status": "pending",
        "config": {
            "service_mode": "",
            "webhook_config": {
                "endpoint": "https://webhook.site/8ed66cc5-8c97-4926-a452-08aed4b450a5",
                "secret": ""
            }
        },
        "input": {
            "video": "https://storage.theapi.app/images/playground/20250725/bf82h5de80b.mp4",
            "invert_output": false
        },
        "output": null,
        "meta": {
            "created_at": "2025-07-25T22:41:18.465048+08:00",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z",
            "usage": {
                "type": "llm",
                "frozen": 0,
                "consume": 280000
            },
            "is_using_private_pool": false
        },
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

Video Remove Background

Overview

Service Limitations

Video Requirements

Pricing

Request

Request samples

Responses

Video Remove Background

Overview#

Service Limitations#

Video Requirements#

Pricing#

Request

Request samples

Responses

Overview

Service Limitations

Video Requirements

Pricing