Publikované

Dokumentácia API Removebg

Cover

Rýchly začiatok

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

Doména požiadavky

https://removebg.one

Koncový bod požiadavky

/api/v1/predict

Vytvorenie API kľúča

Vygenerujte alebo obnovte svoj API kľúč na stránke API kľúča.

Parametre požiadavky

  1. Momentálne je možné prenášať iba objekty typu File prostredníctvom formData, preto vždy nastavte Content-Type na multipart/form-data.

  2. Po vygenerovaní API kľúča na stránke API kľúča nastavte hodnotu kľúča v hlavičke požiadavky Authorization.

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

Nezabudnite nahradiť $API_KEY skutočným API kľúčom.

Parametre odpovede

Kód návratu 0 znamená úspešné zavolanie API. Akýkoľvek iný kód znamená zlyhanie, pričom konkrétny dôvod zlyhania je uvedený v poli správy.

  1. Úspešná odpoveď
{
    "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. Neúspešná odpoveď
{
    "code": 400,
    "message": "Invalid request parameters."
}

Poznámka: URL obrázka vrátené po úspechu je platné iba 1 hodinu. Uistite sa, že ho uložíte alebo včas upozorníte používateľa na základe vášho prípadu použitia.

Príklady kódu

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

Záverečné poznámky

Ak máte akékoľvek otázky, kontaktujte nás na e-mailovej adrese [email protected].

Autori
Logo Removebg