> ## 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 对接说明
> Midjourney generation 集成指南 - XHuoAPI
本文将介绍一种 Midjourney Edits API 对接说明，它是可以通过输入提示词来编辑传入的图片进行生成。
## 申请流程
要使用 API，需要先到 [Midjourney Edits API](https://api.xhuoapi.ai/documents/midjourney-edits) 对应页面申请对应的服务，进入页面之后，点击「Acquire」按钮，如图所示：
如果你尚未登录或注册，会自动跳转到登录页面邀请您来注册和登录，登录注册之后会自动返回当前页面。
在首次申请时会有免费额度赠送，可以免费使用该 API。
## 基本使用
首先先了解下基本的使用方式，就是输入提示词 `prompt`、 生成行为 `action`、参考图片 `image_url`，便可获得处理后的结果，首先需要简单地传递一个 `action` 字段，它的值为 `generate`，具体的内容如下：
可以看到这里我们设置了 Request Headers，包括：
* `accept`：想要接收怎样格式的响应结果，这里填写为 `application/json`，即 JSON 格式。
* `authorization`：调用 API 的密钥，申请之后可以直接下拉选择。
另外设置了 Request Body，包括：
* `mask`：可以指定图像区域的掩码位置以进行编辑和重新生成。
* `split_images`：将生成的图像分割成多个图像，通过sub\_image\_urls字段返回。缺省情况下，为false。
* `action`：此次编辑图片生成任务的行为，默认是 `generate`。
* `image_url`：需要编辑的图片链接。
* `prompt`：提示词。
* `mode`：生成模式，可选 `fast`/`relax`/`turbo`。
* `callback_url`：需要回调结果的URL。
选择之后，可以发现右侧也生成了对应代码，如图所示：
点击「Try」按钮即可进行测试，如上图所示，这里我们就得到了如下结果：
```json theme={null}
{
"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 的代码如下：
```shell theme={null}
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 会立马返回一个结果，包含一个 `task_id` 的字段信息，代表当前的任务 ID。当任务完成之后，生成视频的结果会通过 POST JSON 的形式发送到客户端指定的 `callback_url`，其中也包括了 `task_id` 字段，这样任务结果就可以通过 ID 关联起来了。
下面我们通过示例来了解下具体怎样操作。
首先，Webhook 回调是一个可以接收 HTTP 请求的服务，开发者应该替换为自己搭建的 HTTP 服务器的 URL。此处为了方便演示，使用一个公开的 Webhook 样例网站 [https://webhook.site/，打开该网站即可得到一个](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` 上观察到生成视频的结果，如图所示：
内容如下：
```json theme={null}
{
"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`：Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`：Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`：Too many requests, you have exceeded the rate limit.
* `500 api_error`：Internal server error, something went wrong on the server.
### 错误响应示例
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 结论
通过本文档，您已经了解了如何使用 Midjourney Edits API 可通过输入提示词来对图片进行编辑操作。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。