メインコンテンツへスキップ

インペイント V1

Purpose​

このエンドポイントは画像の特定部分をAIで自然に変更します。アップロードされた画像とプロンプトを基に指定された領域を修正し、望む結果物を生成します。

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)​

フィールド名タイプ必須説明
imagefile必須インペイントする元画像ファイル (PNG, JPG, JPEG等)
promptstring必須インペイント内容を説明するテキストプロンプト

Prompt Guidelines​

  • インペイントする領域と望む結果を具体的に説明してください
  • 例: "背景を青い空に変更", "右上の物体を削除"

Response​

JobIdResponse​

フィールド名タイプ説明
job_idUUID作成されたジョブの一意識別子。このIDでジョブ状態を照会します

Error / Validation Rules​

HTTP状態コードエラー状況説明
400 Bad RequestInvalid image fileInvalid image file
401 Unauthorized認証失敗無効なAPIキーまたは欠落した認証ヘッダー
404 Not FoundユーザーなしAPIキーに関連付けられたユーザーが見つからない
422 Unprocessable Entity検証失敗必須フィールド欠落

Async Job Behavior​

このエンドポイントは非同期で処理されます。リクエスト即座にjob_idを返し、実際のインペイント処理はバックグラウンドで進行します。

ジョブフロー:

  1. 画像ファイルとプロンプトを送信すると即座にjob_idが返されます
  2. バックグラウンドでインペイント処理が進行します
  3. GET /job/{job_id}エンドポイントでポーリングして状態を確認します
  4. 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=背景を青い空に変更"

Response Example​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}