Remove Background - ImaginePro

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

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

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.imaginepro.ai/api/v1/tools/remove-bg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "image": "string",
    "ref": "string",
    "webhookOverride": "YOUR_BACKEND_API_ENDPOINT",
    "timeout": 900
}'

Responses

🟢200Success

application/json

Body

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

Example

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