- Get Started
- Endpoints
- Song(Udio)
- Kling
- Hailuo
- Flux
- AI Hug
- LLM
- Midjourney
- Faceswap
- TTS
- Trellis
- Luma Dream Machine
- WanX
- Skyreels
- Framepack
- Hunyuan Video
- Mmaudio
- DiffRhythm
- Tools
- PiAPI Account Management
- Resources
- Legacy Documentation
Remove Background API
POST
/api/v1/task
Request
Header Params
x-api-key
string
required
Body Params application/json
model
enum<string>
required
Allowed value:
Qubico/image-toolkit
task_type
enum<string>
required
Allowed value:
background-remove
input
object
required
image
string
required
Example
{
"model": "Qubico/image-toolkit",
"task_type": "background-remove",
"input": {
"image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg"
}
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
"model": "Qubico/image-toolkit",
"task_type": "background-remove",
"input": {
"image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg"
}
}'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": "43154fd4-67fe-4xxxx",
"model": "Qubico/image-toolkit",
"task_type": "background-remove",
"status": "success",
"config": {
"service_mode": "",
"webhook_config": {
"endpoint": "",
"secret": ""
}
},
"input": {
"image": "https://xxx.jpg"
},
"output": {
"image_url": "https://xxx.png",
"image_base64": ""
},
"meta": {
"created_at": "",
"started_at": "",
"ended_at": ""
},
"detail": null,
"logs": [],
"error": {
"code": 0,
"raw_message": "",
"message": "",
"detail": null
}
},
"message": "success"
}Modified at 2025-02-19 11:41:29