Remove Background

POST/api/v1/tools/remove-bg

The API to remove background of your image.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

image

string

required

The imagine prompt, you can also include an image URL or other valid parameters in it, same like you using Midjourney in Discord.

ref

string | null

optional

The reference metadata which will return as part of the webhook.

webhookOverride

string | null

optional

The webhook URL which the response will send to, the payload of this webhook is same as our Message endpoint.

Default:

YOUR_BACKEND_API_ENDPOINT

timeout

integer | null

optional

Custom timeout, default to 900 in seconds

>= 10<= 900

Default:

900

{
  "image": "string",
  "ref": "string",
  "webhookOverride": "YOUR_BACKEND_API_ENDPOINT",
  "timeout": 900
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

required

The status of the request.

messageId

string

required

The messageId of the request, which will be used for querying the progress, sending subsequential actions later, etc.

createdAt

string

required

The timestamp of the job creation.

error

string

optional

The error message, if any

{
  "success": true,
  "messageId": "d15c1541-229a-442b-9873-d3494dede12a",
  "createdAt": "2023-08-01T14:03:01.817Z"
}

Last modified: a month ago