Veröffentlicht am

Removebg API-Dokumentation

Cover

Schnellstart

curl --location 'https://removebg.one/api/v1/predict' \
--header 'Authorization: Bearer $API_KEY' \
--form 'file=@"test.png"'

Anforderungs-Domain

https://removebg.one

Anforderungs-Endpunkt

/api/v1/predict

API-Schlüssel erstellen

Generieren oder setzen Sie Ihren API-Schlüssel auf der API-Schlüssel-Seite zurück.

Anforderungsparameter

  1. Derzeit können nur File-Objekte über formData übertragen werden, stellen Sie daher immer sicher, dass der Content-Type auf multipart/form-data gesetzt ist.

  2. Nach der Generierung des API-Schlüssels auf der API-Schlüssel-Seite setzen Sie den Schlüsselwert im Authorization-Header der Anfrage.

Content-Type: multipart/form-data
Authorization: Bearer $API_KEY

Denken Sie daran, $API_KEY durch Ihren tatsächlichen API-Schlüssel zu ersetzen.

Antwortparameter

Ein Rückgabecode von 0 zeigt einen erfolgreichen API-Aufruf an. Jeder andere Code steht für einen Fehler, wobei der spezifische Fehlergrund im Nachrichtenfeld angegeben wird.

  1. Erfolgreiche Antwort
{
    "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=..."
    }
}
  1. Fehlgeschlagene Antwort
{
    "code": 400,
    "message": "Invalid request parameters."
}

Bitte beachten Sie: Die nach dem Erfolg zurückgegebene Bild-URL ist nur 1 Stunde lang gültig. Stellen Sie sicher, dass Sie die URL speichern oder den Benutzer rechtzeitig basierend auf Ihrem Anwendungsfall benachrichtigen.

Codebeispiele

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}')

Abschließende Hinweise

Wenn Sie Fragen haben, senden Sie bitte eine E-Mail an [email protected].

Autoren
Removebg Logo