Remove BG
Purpose
Removes the background from an uploaded image and returns a transparent PNG. This is the same feature as the web app's "Remove BG" page.
Credit cost: 1
Method and Path
POST /public/v1/image-tune/remove-background
Authentication
See the Authentication page. Bearer token is required.
Required Headers:
Authorization: Bearer {your_api_key}
Request Fields
Send the request as multipart/form-data.
| Field Name | Type | Required | Description |
|---|---|---|---|
| image | file | Yes | Image whose background is removed (PNG or JPEG) |
Response
Success Response (200 OK):
{
"job_id": "uuid-string"
}
| Field | Type | Description |
|---|---|---|
| job_id | string | Unique identifier for the created job. Use Get Job Status to retrieve results |
Error / Validation Rules
| Condition | HTTP Status | Error Message |
|---|---|---|
| Image is not a valid PNG or JPEG file | 400 | "Invalid image file" |
| Invalid API key | 401 | "Invalid API key" |
| Missing field | 422 | Validation error |
Async Job Behavior
This endpoint creates an asynchronous job. It immediately returns a job_id, and background removal runs in the background.
Polling Method:
- Save the
job_idreceived in the response - Poll
GET /public/v1/job/{job_id}to check status - When status becomes
Succeed, check the result image inimage_urls
Status Flow: Pending → Succeed or Failed
Example Request
cURL:
curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/remove-background" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png"