Quick Start
curl --location 'https://removebg.one/api/v1/predict' \
--header 'Authorization: Bearer $API_KEY' \
--form 'file=@"test.png"'
Request Domain
https://removebg.one
Request Endpoint
/api/v1/predict
Create API Key
Generate or reset your API Key on the API Key page .
Request Parameters
Currently, only File objects can be transmitted via formData, so please always set the Content-Type to multipart/form-data .
After generating the API Key on the API Key page , set the Key value in the Authorization request header.
Content-Type: multipart/form-data
Authorization: Bearer $API_KEY
Remember to replace $API_KEY with your actual API Key.
Response Parameters
A return code of 0 indicates a successful API call. Any other code represents failure, with the specific failure reason provided in the message field.
Successful Response
{
"code" : 0 ,
"data" : {
"cutoutUrl" : "https://r.removebg.one/static/8d062cc4-7d1d-4390-b958-a88e3a714e68.png?signature=..." ,
"maskUrl" : "https://r.removebg.one/static/acd1904f-e7b6-4e20-92cc-29f19659caf8.png?signature=..."
}
}
Failed Response
{
"code" : 400 ,
"message" : "Invalid request parameters."
}
Please note: The image URL returned after success is only valid for 1 hour. Make sure to save it or notify the user in a timely manner based on your use case.
Code Examples
Fetch
const formData = new FormData ()
formData. append ( 'file' , File)
fetch ( 'https://removebg.one/api/v1/predict' , {
method: 'POST' ,
body: formData,
headers: {
Authorization: 'Bearer $API_KEY' ,
},
})
Java
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.util.EntityUtils;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import java.io.File;
public class RemoveBgApiRequest {
public static void main ( String [] args ) throws Exception {
String apiKey = "YOUR_API_KEY" ; // Replace with your API key
String filePath = "test.png" ; // Replace with your file path
String url = "https://removebg.one/api/v1/predict" ;
File file = new File (filePath);
// Create HTTP client
try (CloseableHttpClient client = HttpClients. createDefault ()) {
HttpPost post = new HttpPost (url);
post. setHeader ( "Authorization" , "Bearer " + apiKey);
// Build multipart form data
FileBody fileBody = new FileBody (file);
HttpEntity entity = MultipartEntityBuilder. create ()
. addPart ( "file" , fileBody)
. build ();
post. setEntity (entity);
// Execute request
String response = EntityUtils. toString (client. execute (post). getEntity ());
// Parse the JSON response
JsonObject jsonResponse = JsonParser. parseString (response). getAsJsonObject ();
int code = jsonResponse. get ( "code" ). getAsInt ();
if (code == 0 ) {
// Success
System.out. println ( "Success: Response data = " + jsonResponse. getAsJsonObject ( "data" ));
} else {
// Failure
String message = jsonResponse. has ( "message" ) ? jsonResponse. get ( "message" ). getAsString () : "Unknown error" ;
System.out. println ( "Failure: " + message);
}
}
}
}
Python
import requests
# Replace with your actual API key
api_key = 'your_api_key_here'
url = 'https://removebg.one/api/v1/predict'
# Path to the image file
file_path = 'test.png'
# Set up the headers with Authorization
headers = {
'Authorization' : f 'Bearer { api_key } '
}
# Open the image file in binary mode
with open (file_path, 'rb' ) as image_file:
# Send the POST request with the file
response = requests.post(url, headers = headers, files = { 'file' : image_file})
# Check the response status
if response.code == 0 :
print ( 'Request successful' )
# You can save or process the response content as needed
with open ( 'output.png' , 'wb' ) as output_file:
output_file.write(response.content)
else :
print ( f 'Error: { response.code } ' )
Final Notes
If you have any questions, please email us at [email protected] .