Objavljeno

Removebg API Dokumentacija

Cover

Hiter začetek

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

Zahteveni domena

https://removebg.one

Zahteveni konec točke

/api/v1/predict

Ustvarite API ključ

Ustvarite ali ponastavite svoj API ključ na strani za API ključe.

Parametri zahtevka

  1. Trenutno je mogoče prenesti le objekti datotek preko formData, zato vedno nastavite Content-Type na multipart/form-data.

  2. Po ustvarjanju API ključa na strani za API ključe, nastavite vrednost ključa v Authorization glavi zahtevka.

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

Ne pozabite zamenjati $API_KEY z vašim dejanskim API ključem.

Parametri odgovora

Koda vrnitve 0 pomeni uspešen klic API-ja. Vsaka druga koda pomeni napako, pri čemer je specifičen razlog napake naveden v polju sporočila.

  1. Uspešen odgovor
{
    "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. Neuspešen odgovor
{
    "code": 400,
    "message": "Invalid request parameters."
}

Prosimo, upoštevajte: URL slike, vrnjen po uspehu, je veljaven samo eno uro. Poskrbite, da jo shranite ali obvestite uporabnika pravočasno, glede na vaš primer uporabe.

Primeri kode

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

Končne opombe

Če imate kakršna koli vprašanja, nas kontaktirajte po e-pošti na [email protected].

Avtorji
Logotip Removebg