> ## 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

> Быстрый старт для Midjourney API на CometAPI: отправьте /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`                     |

***

## Полная схема workflow

```
┌─────────────────────────────────────────────────────────────────────────────┐
│                         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-grid)

Эти кнопки возвращаются, когда завершается первоначальная генерация изображения:

| Button | customId Pattern                | Action                     | Result                                |
| ------ | ------------------------------- | -------------------------- | ------------------------------------- |
| U1-U4  | `MJ::JOB::upsample::1::xxx`     | Апскейл одного изображения | Одно изображение в высоком разрешении |
| V1-V4  | `MJ::JOB::variation::1::xxx`    | Сгенерировать вариации     | Новый 4-grid                          |
| 🔄     | `MJ::JOB::reroll::0::xxx::SOLO` | Сгенерировать заново всё   | Новый 4-grid                          |

### После 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` могут различаться в зависимости от версии MJ, указанной в вашем prompt (например, `--v 6.1` vs `--v 5.2`). Всегда считывайте кнопки из ответа API.

<Warning>
  Кнопка Inpaint (Vary Region) появляется только после Upscale.
</Warning>

***

## Полный пример: генерация и апскейл

### Шаг 1: Отправьте imagine request

```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-grid                   | Сначала выполните Upscale (нажмите U1-U4), затем проверьте кнопки                                                                     |
| Статус задачи завис на `MODAL`        | Операция требует дополнительного ввода               | Вызовите [`/mj/submit/modal`](/api/image/midjourney/modal) с требуемыми данными                                                       |
| `customId` не работает                | Используется устаревшее или жёстко заданное значение | Всегда получайте актуальный `customId` из ответа [`/mj/task/\{id\}/fetch`](/api/image/midjourney/task-fetching-api/fetch-single-task) |
| Пустой массив `buttons`               | Задача всё ещё выполняется                           | Дождитесь `status: "SUCCESS"` перед обращением к кнопкам                                                                              |