> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 开始使用 Midjourney API

> CometAPI 上 Midjourney API 的快速入门：提交 /mj/submit/imagine，轮询 /mj/task/{id}/fetch，然后使用 /mj/submit/action 和 modal 按钮。

## 理解核心概念

MidJourney API **模拟 Discord 按钮交互**。与典型的 REST API 不同，它以**状态机**的方式工作，其中每次操作都会返回下一步所需的新按钮。

### 4 个核心 API

| API                                                                                      | 用途                        | 何时使用              |
| ---------------------------------------------------------------------------------------- | ------------------------- | ----------------- |
| [`POST /mj/submit/imagine`](/api/image/midjourney/imagine)                               | 文生图生成                     | 所有工作流的起点          |
| [`GET /mj/task/\{id\}/fetch`](/api/image/midjourney/task-fetching-api/fetch-single-task) | 查询任务状态并获取按钮               | 每次提交后都使用（轮询直到完成）  |
| [`POST /mj/submit/action`](/api/image/midjourney/action)                                 | 点击按钮（upscale、vary、zoom 等） | 当你想对图像进行操作时       |
| [`POST /mj/submit/modal`](/api/image/midjourney/modal)                                   | 提交额外输入                    | 仅当状态为 `MODAL` 时使用 |

***

## 完整工作流图

```
┌─────────────────────────────────────────────────────────────────────────────┐
│                         MIDJOURNEY API WORKFLOW                             │
└─────────────────────────────────────────────────────────────────────────────┘

  ┌──────────────────┐
  │  POST /submit/   │  ← Step 1: Submit prompt, get task_id
  │     imagine      │
  └────────┬─────────┘
           │ Returns: { "result": "task_id_1" }
           ▼
  ┌──────────────────┐
  │ GET /task/{id}/  │  ← Step 2: Poll until status = "SUCCESS"
  │      fetch       │
  └────────┬─────────┘
           │ Returns: imageUrl + buttons[] (U1,U2,U3,U4,V1,V2,V3,V4,🔄)
           ▼
  ┌──────────────────┐
  │  POST /submit/   │  ← Step 3: Click a button using customId
  │     action       │
  └────────┬─────────┘
           │ Returns: { "result": "task_id_2" }
           ▼
  ┌──────────────────┐
  │ GET /task/{id}/  │  ← Step 4: Poll the new task
  │      fetch       │
  └────────┬─────────┘
           │
           ├─── status = "SUCCESS" → Done! Get imageUrl
           │
           └─── status = "MODAL" → Need additional input (see Step 5)
                      │
                      ▼
           ┌──────────────────┐
           │  POST /submit/   │  ← Step 5: Submit mask/prompt for special operations
           │      modal       │
           └────────┬─────────┘
                    │ Returns: { "result": "task_id_3" }
                    ▼
           ┌──────────────────┐
           │ GET /task/{id}/  │  ← Step 6: Poll until SUCCESS
           │      fetch       │
           └──────────────────┘
```

***

## 关键概念：按钮和 customId

每个成功的任务都会返回一个 `buttons` 数组。每个按钮都有一个 `customId`，你可以用它来触发下一步操作。

**来自 `/mj/task/\{id\}/fetch` 的响应示例：**

```json theme={null}
{
  "status": "SUCCESS",
  "imageUrl": "https://api.cometapi.com/mj/image/xxx",
  "buttons": [
    { "customId": "MJ::JOB::upsample::1::abc123", "label": "U1" },
    { "customId": "MJ::JOB::upsample::2::abc123", "label": "U2" },
    { "customId": "MJ::JOB::variation::1::abc123", "label": "V1" },
    { "customId": "MJ::JOB::reroll::0::abc123", "emoji": "🔄" }
  ]
}
```

<Warning>
  `customId` 不是固定值。它会随着每个任务而变化。请始终从 `buttons` 数组中获取它。
</Warning>

***

## 按阶段划分的按钮参考

### IMAGINE 之后（4 宫格图像）

当你的初始图像生成完成后，会返回这些按钮：

| Button | customId Pattern                | Action | Result  |
| ------ | ------------------------------- | ------ | ------- |
| U1-U4  | `MJ::JOB::upsample::1::xxx`     | 放大单张图像 | 高分辨率单图  |
| V1-V4  | `MJ::JOB::variation::1::xxx`    | 生成变体   | 新的 4 宫格 |
| 🔄     | `MJ::JOB::reroll::0::xxx::SOLO` | 重新生成全部 | 新的 4 宫格 |

### UPSCALE 之后（单张图像）

放大后，你可以使用这些编辑工具：

| Label                             | Needs Modal? |
| --------------------------------- | ------------ |
| Upscale (Subtle) / Upscale (2x)   | ❌ 否          |
| Upscale (Creative) / Upscale (4x) | ❌ 否          |
| Vary (Subtle) 🪄                  | ❌ 否          |
| Vary (Strong) 🪄                  | ❌ 否          |
| Vary (Region) 🖌️                 | ✅ 是（mask）    |
| Zoom Out 2x / 1.5x 🔍             | ❌ 否          |
| Custom Zoom 🔍                    | ✅ 是（prompt）  |
| ⬅️➡️⬆️⬇️ Pan                      | ❌ 否          |
| Animate 🎞️                       | ❌ 否          |
| 🔄 Reroll                         | ❌ 否          |

> **注意：** 按钮标签和 `customId` 格式可能会因你在 prompt 中指定的 MJ 版本而有所不同（例如 `--v 6.1` 与 `--v 5.2`）。请始终从 API 响应中读取按钮信息。

<Warning>
  Inpaint（Vary Region）按钮只会在 Upscale 之后出现。
</Warning>

***

## 完整示例：生成并放大

### 第 1 步：提交 imagine 请求

```bash theme={null}
curl -X POST 'https://api.cometapi.com/mj/submit/imagine' \
  -H "Authorization: Bearer $COMETAPI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "botType": "MID_JOURNEY",
    "prompt": "a cute cat --v 6.1",
    "accountFilter": { "modes": ["FAST"] }
  }'
```

**响应：**

```json theme={null}
{ "code": 1, "result": "1768464763141701" }
```

### 第 2 步：轮询任务状态

```bash theme={null}
curl -X GET 'https://api.cometapi.com/mj/task/1768464763141701/fetch' \
  -H "Authorization: Bearer $COMETAPI_KEY"
```

**响应（完成时）：**

```json theme={null}
{
  "status": "SUCCESS",
  "imageUrl": "https://api.cometapi.com/mj/image/1768464763141701",
  "buttons": [
    { "customId": "MJ::JOB::upsample::1::5f20922e-xxx", "label": "U1" },
    { "customId": "MJ::JOB::upsample::2::5f20922e-xxx", "label": "U2" },
    ...
  ]
}
```

### 第 3 步：点击 U1 进行放大

```bash theme={null}
curl -X POST 'https://api.cometapi.com/mj/submit/action' \
  -H "Authorization: Bearer $COMETAPI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "taskId": "1768464763141701",
    "customId": "MJ::JOB::upsample::1::5f20922e-xxx"
  }'
```

**响应：**

```json theme={null}
{ "code": 1, "result": "1768464800000000" }
```

### 第 4 步：轮询新任务并获取结果

```bash theme={null}
curl -X GET 'https://api.cometapi.com/mj/task/1768464800000000/fetch' \
  -H "Authorization: Bearer $COMETAPI_KEY"
```

***

## 什么时候需要 Modal？

当你调用 [`/mj/submit/action`](/api/image/midjourney/action) 且任务状态变为 `MODAL` 而不是 `SUCCESS` 时，你必须调用 [`/mj/submit/modal`](/api/image/midjourney/modal) 来提供额外输入。

### 已确认需要 Modal 的操作

| Operation   | Button         | What to Submit                        |
| ----------- | -------------- | ------------------------------------- |
| Inpaint     | Vary (Region)  | `maskBase64`（PNG mask）+ `prompt`      |
| Custom Zoom | 🔍 Custom Zoom | `prompt`（例如 `"your prompt --zoom 2"`） |

**示例：Inpaint 流程**

```bash theme={null}
# 1. Click Vary (Region) button via Action API
curl -X POST 'https://api.cometapi.com/mj/submit/action' \
  -H "Authorization: Bearer $COMETAPI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"taskId": "xxx", "customId": "MJ::Inpaint::xxx", "enableRemix": true}'

# 2. Poll and see status = "MODAL"
curl -X GET 'https://api.cometapi.com/mj/task/new_task_id/fetch'
# Response: { "status": "MODAL" }

# 3. Submit mask and prompt via Modal API
curl -X POST 'https://api.cometapi.com/mj/submit/modal' \
  -H "Authorization: Bearer $COMETAPI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "taskId": "new_task_id",
    "prompt": "replace with golden crown",
    "maskBase64": "data:image/png;base64,..."
  }'
```

***

## 速度模式选择

在路径中添加速度前缀：

| 模式    | 路径前缀        | 示例                            |
| ----- | ----------- | ----------------------------- |
| Fast  | `/mj-fast`  | `/mj-fast/mj/submit/imagine`  |
| Turbo | `/mj-turbo` | `/mj-turbo/mj/submit/imagine` |
| Relax | （默认）        | `/mj/submit/imagine`          |

***

## 其他入口点

这些 API 是**独立入口点**，不遵循 imagine → action 流程：

| API                                                            | 用途             |
| -------------------------------------------------------------- | -------------- |
| [`POST /mj/submit/blend`](/api/image/midjourney/blend)         | 将 2-5 张图片混合为一张 |
| [`POST /mj/submit/describe`](/api/image/midjourney/describe)   | 根据图片生成 prompt  |
| [`POST /mj/submit/video`](/api/image/midjourney/submit-video)  | 将图片转换为视频       |
| [`POST /mj/submit/edits`](/api/image/midjourney/submit-editor) | 使用蒙版编辑图片       |

***

## 故障排查提示

基于 API 设计和工作流，以下是你可能遇到的常见问题：

| 问题                   | 可能原因        | 解决方案                                                                                                          |
| -------------------- | ----------- | ------------------------------------------------------------------------------------------------------------- |
| 找不到 Vary (Region) 按钮 | 正在查看 4 宫格图片 | 先放大（点击 U1-U4），然后再检查按钮                                                                                         |
| 任务状态卡在 `MODAL`       | 操作需要额外输入    | 使用所需数据调用 [`/mj/submit/modal`](/api/image/midjourney/modal)                                                    |
| `customId` 无法使用      | 使用了过时或硬编码的值 | 始终从 [`/mj/task/\{id\}/fetch`](/api/image/midjourney/task-fetching-api/fetch-single-task) 的响应中获取最新的 `customId` |
| `buttons` 数组为空       | 任务仍在处理中     | 在访问按钮之前，先等待 `status: "SUCCESS"`                                                                               |