Remove Background API

POST/api/v1/task

Pricing: $0.001/generation

Request

Header Params

x-api-key

string

required

Your API Key for authorization

model

enum<string>

required

Allowed value:

Qubico/image-toolkit

task_type

enum<string>

required

Allowed value:

background-remove

input

object

required

image

string

required

{
  "model": "Qubico/image-toolkit",
  "task_type": "background-remove",
  "input": {
    "image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg"
  }
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

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

{
  "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"
}

Last modified: a month ago