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

# Comece com a API Midjourney

> Início rápido para a API Midjourney no CometAPI: envie /mj/submit/imagine, consulte /mj/task/{id}/fetch, depois use /mj/submit/action e botões modal.

## Entenda o conceito central

A API MidJourney **simula interações de botões do Discord**. Diferente de APIs REST típicas, ela funciona como uma **máquina de estados** em que cada operação retorna novos botões para a próxima etapa.

### As 4 APIs principais

| API                                                                                      | Finalidade                                     | Quando usar                                 |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------- |
| [`POST /mj/submit/imagine`](/api/image/midjourney/imagine)                               | Geração de texto para imagem                   | Ponto de partida para todos os fluxos       |
| [`GET /mj/task/\{id\}/fetch`](/api/image/midjourney/task-fetching-api/fetch-single-task) | Consultar status da tarefa e obter botões      | Após cada envio (faça polling até concluir) |
| [`POST /mj/submit/action`](/api/image/midjourney/action)                                 | Clicar em um botão (upscale, vary, zoom, etc.) | Quando você quiser operar em uma imagem     |
| [`POST /mj/submit/modal`](/api/image/midjourney/modal)                                   | Enviar entrada adicional                       | Somente quando o status for `MODAL`         |

***

## Diagrama completo do fluxo

```
┌─────────────────────────────────────────────────────────────────────────────┐
│                         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       │
           └──────────────────┘
```

***

## Conceito-chave: Buttons e customId

Toda tarefa bem-sucedida retorna um array `buttons`. Cada botão tem um `customId` que você usa para acionar a próxima ação.

**Exemplo de resposta de `/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` não é um valor fixo. Ele muda em cada tarefa. Sempre obtenha-o do array `buttons`.
</Warning>

***

## Referência de botões por etapa

### Após IMAGINE (imagem em grade 4)

Esses botões são retornados quando a geração inicial da sua imagem é concluída:

| Button | customId Pattern                | Action               | Result                         |
| ------ | ------------------------------- | -------------------- | ------------------------------ |
| U1-U4  | `MJ::JOB::upsample::1::xxx`     | Ampliar imagem única | Imagem única em alta resolução |
| V1-V4  | `MJ::JOB::variation::1::xxx`    | Gerar variações      | Nova grade 4                   |
| 🔄     | `MJ::JOB::reroll::0::xxx::SOLO` | Regenerar tudo       | Nova grade 4                   |

### Após UPSCALE (imagem única)

Após fazer upscale, você tem acesso às ferramentas de edição:

| Label                             | Needs Modal?    |
| --------------------------------- | --------------- |
| Upscale (Subtle) / Upscale (2x)   | ❌ Não           |
| Upscale (Creative) / Upscale (4x) | ❌ Não           |
| Vary (Subtle) 🪄                  | ❌ Não           |
| Vary (Strong) 🪄                  | ❌ Não           |
| Vary (Region) 🖌️                 | ✅ Sim (máscara) |
| Zoom Out 2x / 1.5x 🔍             | ❌ Não           |
| Custom Zoom 🔍                    | ✅ Sim (prompt)  |
| ⬅️➡️⬆️⬇️ Pan                      | ❌ Não           |
| Animate 🎞️                       | ❌ Não           |
| 🔄 Reroll                         | ❌ Não           |

> **Observação:** Os rótulos dos botões e os formatos de `customId` podem variar dependendo da versão do MJ especificada no seu prompt (por exemplo, `--v 6.1` vs `--v 5.2`). Sempre leia os botões da resposta da API.

<Warning>
  O botão Inpaint (Vary Region) só aparece após o Upscale.
</Warning>

***

## Exemplo completo: gerar e ampliar

### Etapa 1: Enviar solicitação 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"] }
  }'
```

**Resposta:**

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

### Etapa 2: Consultar o status da tarefa

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

**Resposta (quando concluída):**

```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" },
    ...
  ]
}
```

### Etapa 3: Clicar em U1 para ampliar

```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"
  }'
```

**Resposta:**

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

### Etapa 4: Consultar a nova tarefa e obter o resultado

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

***

## Quando o Modal é necessário?

Quando você chama [`/mj/submit/action`](/api/image/midjourney/action) e o status da tarefa se torna `MODAL` em vez de `SUCCESS`, você deve chamar [`/mj/submit/modal`](/api/image/midjourney/modal) para fornecer informações adicionais.

### Operações com Modal confirmadas

| Operation   | Button         | What to Submit                                 |
| ----------- | -------------- | ---------------------------------------------- |
| Inpaint     | Vary (Region)  | `maskBase64` (máscara PNG) + `prompt`          |
| Custom Zoom | 🔍 Custom Zoom | `prompt` (por exemplo, "your prompt --zoom 2") |

**Exemplo: fluxo de 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,..."
  }'
```

***

## Seleção do modo de velocidade

Adicione o prefixo de velocidade ao caminho:

| Modo   | Prefixo do caminho | Exemplo                       |
| ------ | ------------------ | ----------------------------- |
| Rápido | `/mj-fast`         | `/mj-fast/mj/submit/imagine`  |
| Turbo  | `/mj-turbo`        | `/mj-turbo/mj/submit/imagine` |
| Relax  | (padrão)           | `/mj/submit/imagine`          |

***

## Outros pontos de entrada

Essas APIs são **pontos de entrada independentes** que não seguem o fluxo imagine → action:

| API                                                            | Finalidade                            |
| -------------------------------------------------------------- | ------------------------------------- |
| [`POST /mj/submit/blend`](/api/image/midjourney/blend)         | Mescla 2 a 5 imagens em uma só        |
| [`POST /mj/submit/describe`](/api/image/midjourney/describe)   | Gera um prompt a partir de uma imagem |
| [`POST /mj/submit/video`](/api/image/midjourney/submit-video)  | Converte imagem em vídeo              |
| [`POST /mj/submit/edits`](/api/image/midjourney/submit-editor) | Edita imagem com máscara              |

***

## Dicas de solução de problemas

Com base no design e no fluxo da API, aqui estão alguns problemas comuns que você pode encontrar:

| Problema                                       | Causa provável                               | Solução                                                                                                                               |
| ---------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Não é possível encontrar o botão Vary (Region) | Visualizando imagem em grade 4               | Faça upscale primeiro (clique em U1-U4) e depois verifique os botões                                                                  |
| Status da tarefa travado em `MODAL`            | A operação requer entrada adicional          | Chame [`/mj/submit/modal`](/api/image/midjourney/modal) com os dados necessários                                                      |
| `customId` não funciona                        | Uso de valor desatualizado ou fixo no código | Sempre obtenha um `customId` novo da resposta de [`/mj/task/\{id\}/fetch`](/api/image/midjourney/task-fetching-api/fetch-single-task) |
| Array `buttons` vazio                          | A tarefa ainda está em andamento             | Aguarde `status: "SUCCESS"` antes de acessar os botões                                                                                |