Documentation Index
Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
Use this file to discover all available pages before exploring further.
本文では、入力プロンプトを使用して受信した画像を編集して生成することができる Midjourney Edits API の接続説明を紹介します。
申請プロセス
APIを使用するには、まず Midjourney Edits API の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：
まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。
初回申請時には無料のクレジットが付与され、このAPIを無料で使用できます。
基本使用
まず、基本的な使用方法を理解します。入力プロンプト prompt、生成行動 action、参照画像 image_url を入力することで、処理された結果を得ることができます。まず、シンプルに action フィールドを渡す必要があります。その値は generate です。具体的な内容は以下の通りです：
ここでは、リクエストヘッダーを設定しています。含まれるのは：
accept：受け取りたいレスポンス結果の形式。ここでは application/json、つまりJSON形式を記入します。authorization：APIを呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
また、リクエストボディを設定しています。含まれるのは：
mask：編集と再生成のために画像領域のマスク位置を指定できます。split_images：生成された画像を複数の画像に分割し、sub_image_urlsフィールドで返します。デフォルトではfalseです。action：今回の画像編集生成タスクの行動。デフォルトは generate です。image_url：編集する画像のリンク。prompt：プロンプト。mode：生成モード。選択肢は fast/relax/turbo です。callback_url：結果をコールバックするURL。
選択後、右側にも対応するコードが生成されているのがわかります。以下の図のように：
「Try」ボタンをクリックするとテストが行えます。上の図のように、以下の結果が得られました：
{
"sub_image_urls": [
"https://cdn.midjourney.com/88e16dab-ef48-43a5-af73-bf24065287bc/0_0.png",
"https://cdn.midjourney.com/88e16dab-ef48-43a5-af73-bf24065287bc/0_1.png",
"https://cdn.midjourney.com/88e16dab-ef48-43a5-af73-bf24065287bc/0_2.png",
"https://cdn.midjourney.com/88e16dab-ef48-43a5-af73-bf24065287bc/0_3.png"
],
"image_url": "https://storage.fonedis.cc/attachments/1372468820912115716/1391371957878132849/cat_sitting_table_88e16dab-ef48-43a5-af73-bf24065287bc.png?ex=686ba79d&is=686a561d&hm=ad005d06f6673d6152456e04c3cbec39d062bd9df10448623fae27ddaf8b8a80&",
"image_width": 960,
"image_height": 1200,
"raw_image_url": "https://storage.fonedis.cc/attachments/1372468820912115716/1391371957878132849/cat_sitting_table_88e16dab-ef48-43a5-af73-bf24065287bc.png?ex=686ba79d&is=686a561d&hm=ad005d06f6673d6152456e04c3cbec39d062bd9df10448623fae27ddaf8b8a80&",
"raw_image_width": 960,
"raw_image_height": 1200,
"progress": 100,
"image_id": "1391372193836826624",
"task_id": "26c39859-f54a-4998-9e42-3da96eceee8c",
"success": true
}
success：この時点での画像編集生成タスクの状態。task_id：この時点での画像編集生成タスクID。image_id：今回の画像編集タスクの画像ID。sub_image_urls：画像生成タスクの複数の画像結果。image_url：画像生成結果の画像リンク。image_width：画像生成結果の幅。image_height：画像生成結果の高さ。progress：この時点での画像編集生成タスクの進捗フィールド。
満足のいく画像情報が得られたことがわかります。結果の中の image_url の画像リンクアドレスを取得するだけで生成された画像を得ることができます。
また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURLのコードは以下の通りです：
curl -X POST 'https://api.xhuoapi.ai/v1/midjourney/edits' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"prompt": "A cat sitting on a table",
"split_images": true,
"image_url": "https://cdn.xhuoapi.ai/jgo1cw.jpg",
"action": "generate"
}'
非同期コールバック
Midjourney Edits APIの生成には比較的長い時間がかかります。約1〜2分かかります。APIが長時間応答しない場合、HTTPリクエストは接続を維持し続け、追加のシステムリソースを消費します。そのため、本APIは非同期コールバックのサポートも提供しています。
全体の流れは、クライアントがリクエストを発行する際に、追加で callback_url フィールドを指定します。クライアントがAPIリクエストを発行すると、APIはすぐに結果を返し、現在のタスクIDを示す task_id フィールド情報を含みます。タスクが完了すると、生成された結果はPOST JSON形式でクライアントが指定した callback_url に送信され、その中にも task_id フィールドが含まれます。これにより、タスク結果をIDで関連付けることができます。
以下の例を通じて、具体的にどのように操作するかを理解しましょう。
まず、WebhookコールバックはHTTPリクエストを受け取ることができるサービスであり、開発者は自分が構築したHTTPサーバーのURLに置き換える必要があります。ここでは、デモのために公開されたWebhookサンプルサイト https://webhook.site/ を使用します。このサイトを開くとWebhook URLが得られます。以下の図のように：
このURLをコピーすればWebhookとして使用できます。このサンプルは https://webhook.site/556e6971-b41f-4fa8-9151-6e91acd0399f です。
次に、フィールド callback_url を上記のWebhook URLに設定し、対応するパラメータを入力します。具体的な内容は以下の図のように：
実行をクリックすると、すぐに結果が得られます。以下のように：
{
"task_id": "b8b7fdc2-628e-40dd-bc0c-671c3ddac9e9"
}
https://webhook.site/556e6971-b41f-4fa8-9151-6e91acd0399f で生成された結果を観察できます。以下の図のように：
内容は以下の通りです：
{
"sub_image_urls": [
"https://cdn.midjourney.com/f3638ed2-60f6-49dd-897a-6d68c15afb17/0_0.png",
"https://cdn.midjourney.com/f3638ed2-60f6-49dd-897a-6d68c15afb17/0_1.png",
"https://cdn.midjourney.com/f3638ed2-60f6-49dd-897a-6d68c15afb17/0_2.png",
"https://cdn.midjourney.com/f3638ed2-60f6-49dd-897a-6d68c15afb17/0_3.png"
],
"image_url": "https://storage.fonedis.cc/attachments/1372468820912115716/1391374307719905340/cat_sitting_table_f3638ed2-60f6-49dd-897a-6d68c15afb17.png?ex=686ba9cd&is=686a584d&hm=71543c21c38db8a50c7ebcf54bc5208ec349e8592ec9e332f778f74167000ced&",
"image_width": 960,
"image_height": 1200,
"raw_image_url": "https://storage.fonedis.cc/attachments/1372468820912115716/1391374307719905340/cat_sitting_table_f3638ed2-60f6-49dd-897a-6d68c15afb17.png?ex=686ba9cd&is=686a584d&hm=71543c21c38db8a50c7ebcf54bc5208ec349e8592ec9e332f778f74167000ced&",
"raw_image_width": 960,
"raw_image_height": 1200,
"progress": 100,
"image_id": "1391374390892953600",
"task_id": "b8b7fdc2-628e-40dd-bc0c-671c3ddac9e9",
"success": true
}
task_id フィールドが含まれており、他のフィールドは前述の内容と類似しています。このフィールドを通じてタスクの関連付けが可能です。
エラーハンドリング
APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードとメッセージを返します。例えば：
400 token_mismatched：不正なリクエスト、パラメータが不足しているか無効である可能性があります。400 api_not_implemented：不正なリクエスト、パラメータが不足しているか無効である可能性があります。401 invalid_token：認証されていない、無効または不足している認証トークン。429 too_many_requests：リクエストが多すぎます、レート制限を超えました。500 api_error：内部サーバーエラー、サーバーで何かがうまくいきませんでした。
エラー応答の例
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
