نُشر في

توثيق واجهة برمجة التطبيقات Removebg

Cover

بداية سريعة

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

نطاق الطلب

https://removebg.one

نقطة النهاية للطلب

/api/v1/predict

إنشاء مفتاح واجهة برمجة التطبيقات

قم بإنشاء أو إعادة تعيين مفتاح واجهة برمجة التطبيقات الخاص بك على صفحة مفتاح واجهة برمجة التطبيقات.

معلمات الطلب

  1. حاليًا، يمكن إرسال كائنات الملفات فقط عبر formData، لذا يرجى دائمًا تعيين Content-Type إلى multipart/form-data.

  2. بعد إنشاء مفتاح واجهة برمجة التطبيقات على صفحة مفتاح واجهة برمجة التطبيقات، قم بتعيين قيمة المفتاح في رأس الطلب Authorization.

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

تأكد من استبدال $API_KEY بمفتاح واجهة برمجة التطبيقات الفعلي الخاص بك.

معلمات الاستجابة

يشير رمز العودة 0 إلى نجاح مكالمة واجهة برمجة التطبيقات. أي رمز آخر يمثل فشلًا، مع توفير السبب المحدد للفشل في حقل الرسالة.

  1. استجابة ناجحة
{
    "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. استجابة فاشلة
{
    "code": 400,
    "message": "Invalid request parameters."
}

يرجى ملاحظة: رابط الصورة الذي يتم إرجاعه بعد النجاح صالح لمدة ساعة واحدة فقط. تأكد من حفظه أو إخطار المستخدم في الوقت المناسب بناءً على حالة الاستخدام الخاصة بك.

أمثلة على الكود

جلب

const formData = new FormData()
formData.append('file', File)
fetch('https://removebg.one/api/v1/predict', {
  method: 'POST',
  body: formData,
  headers: {
    Authorization: 'Bearer $API_KEY',
  },
})

جافا

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

بايثون

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

الملاحظات النهائية

إذا كانت لديك أي أسئلة، يرجى إرسال بريد إلكتروني لنا على [email protected].

المؤلفون
  • avatar
    الاسم
    الرسمي
    الموقع الإلكتروني
    Removebg