Split Layer
Purpose
This endpoint separates uploaded images into layers. It extracts specific elements from the image as individual layers based on keywords.
Method and Path
- HTTP Method:
POST - Path:
/public/v1/image-tune/split-layer
Authentication
This endpoint requires Bearer Token authentication. See the Authentication Guide for details.
Required Headers:
Authorization: Bearer {your_api_key}
Request Fields
Form Data (multipart/form-data)
| Field Name | Type | Required | Description |
|---|---|---|---|
image | file | Required | Original image file to split into layers (PNG, JPG, JPEG, etc.) |
keyword | string | Required | Keyword specifying the element to separate |
Keyword Guidelines
- Enter a keyword describing the image element you want to separate
- Examples:
"arm","body","leg"
Response
JobIdResponse
| Field Name | Type | Description |
|---|---|---|
job_id | UUID | Unique identifier for the created job. Use this ID to check job status |
Error / Validation Rules
| HTTP Status Code | Error Condition | Description |
|---|---|---|
400 Bad Request | Invalid image file | Invalid image file |
401 Unauthorized | Authentication failed | Invalid API key or missing authentication header |
404 Not Found | User not found | User associated with API key cannot be found |
422 Unprocessable Entity | Validation failed | Required field missing |
Async Job Behavior
This endpoint is processed asynchronously. It immediately returns a job_id, and actual layer split processing occurs in the background.
Job Flow:
- Send the image file and keyword to immediately receive a
job_id - Layer split processing occurs in the background
- Poll the
GET /job/{job_id}endpoint to check status - When
statuschanges toSucceed, check the separated layer image URLs inimage_urls
Recommended Polling Interval: 1-2 seconds
Example Request
cURL
curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/split-layer" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/your/image.png" \
-F "keyword=character"
Response Example
{
"job_id": "550e8400-e29b-41d4-a716-446655440000"
}