POST /image-tune/inpaint/v1
Purpose
このエンドポイントは画像の特定部分をAIで自然に変更します。アップロードされた画像とプロンプトを基に指定された領域を修正し、望む結果物を生成します。ウェブアプリの「画像を描き直す」ページの V1 タブと同じ機能です(ウェブアプリはデフォルトで V2 タブ を開きます)。
クレジット消費: 5
Method and Path
- HTTP Method:
POST - Path:
/public/v1/image-tune/inpaint/v1
Authentication
このエンドポイントはBearer Token認証が必要です。詳細については認証ガイドを参照してください。
必須ヘッダー:
Authorization: Bearer {your_api_key}
Request Fields
Form Data (multipart/form-data)
| フィールド名 | タイプ | 必須 | 説明 |
|---|---|---|---|
image | file | 必須 | 描き直す元画像ファイル (PNG または JPEG) |
prompt | string | 必須 | 描き直す内容を説明するテキストプロンプト |
Prompt Guidelines
- 描き直す領域と望む結果を具体的に説明してください
- 例:
"Change background to blue sky","Remove object in upper right corner"
Response
JobIdResponse
| フィールド名 | タイプ | 説明 |
|---|---|---|
job_id | UUID | 作成されたジョブの一意識別子。このIDでジョブ状態を照会します |
Error / Validation Rules
| HTTP状態コード | エラー状況 | 説明 |
|---|---|---|
400 Bad Request | Invalid image file | Invalid image file |
401 Unauthorized | 認証失敗 | 無効なAPIキーまたは欠落した認証ヘッダー |
404 Not Found | ユーザーなし | APIキーに関連付けられたユーザーが見つからない |
422 Unprocessable Entity | 検証失敗 | 必須フィールド欠落 |
Async Job Behavior
このエンドポイントは非同期で処理されます。リクエスト即座にjob_idを返し、実際の描き直し処理はバックグラウンドで進行します。
ジョブフロー:
- 画像ファイルとプロンプトを送信すると即座に
job_idが返されます - バックグラウンドで描き直し処理が進行します
GET /job/{job_id}エンドポイントでポーリングして状態を確認しますstatusがSucceedに変更されるとimage_urlsで結果画像URLを確認します
ポーリング間隔: 1-2秒推奨
Example Request
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=Change background to blue sky"
Response Example
{
"job_id": "550e8400-e29b-41d4-a716-446655440000"
}