POST /image-tune/inpaint/v1
用途
此端點使用 AI 自然修改影像的特定部分。根據上傳的影像與提示，修改指定區域以產生想要的結果。
方法與路徑
- HTTP Method:
POST - Path:
/public/v1/image-tune/inpaint/v1
認證
此端點需要 Bearer Token 認證。詳細資訊請參閱認證指南。
必要標頭：
Authorization: Bearer {your_api_key}
請求欄位
表單資料 (multipart/form-data)
| 欄位名 | 類型 | 必填 | 說明 |
|---|---|---|---|
image | file | 必填 | 要修復的原始影像檔案 (PNG, JPG, JPEG 等) |
prompt | string | 必填 | 描述修復內容的文字提示 |
Prompt 指南
- 具體描述要修復的區域與想要的結果
- 例如：
"將背景改為藍天","移除右上角的物體"
回應
JobIdResponse
| 欄位名 | 類型 | 說明 |
|---|---|---|
job_id | UUID | 已建立作業的唯一識別碼。使用此 ID 查詢作業狀態 |
錯誤 / 驗證規則
| HTTP 狀態碼 | 錯誤情境 | 說明 |
|---|---|---|
400 Bad Request | Invalid image file | Invalid image file |
401 Unauthorized | 認證失敗 | 無效的 API 金鑰或遺漏的認證標頭 |
404 Not Found | 使用者不存在 | 找不到 API 金鑰連結的使用者 |
422 Unprocessable Entity | 驗證失敗 | 必填欄位遺漏 |
非同步作業行為
此端點以非同步方式處理。請求立即回傳 job_id，實際修復處理於背景進行。
作業流程：
- 傳送影像檔案與提示後立即回傳
job_id - 背景進行修復處理
- 使用
GET /job/{job_id}端點輪詢確認狀態 status變更為Succeed時，於image_urls查看結果影像 URL
輪詢間隔： 建議 1-2 秒
請求範例
cURL
curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/inpaint/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/your/image.png" \
-F "prompt=將背景改為藍天"
回應範例
{
"job_id": "550e8400-e29b-41d4-a716-446655440000"
}