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

# Modal（提交补充参数）

> 给 MODAL 状态的局部重绘任务补充 mask + prompt 完成重绘

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://gccai.heqingsong.uk/v1/midjourney/generations/modal \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
      "prompt": "replace the selected area with a red leather sofa",
      "mask_url": "https://example.com/mask.png",
      "speed": "fast"
    }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal"

  payload = {
      "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
      "prompt": "replace the selected area with a red leather sofa",
      "mask_url": "https://example.com/mask.png",
      "speed": "fast"
  }

  headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal";

  const payload = {
    task_id: "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
    prompt: "replace the selected area with a red leather sofa",
    mask_url: "https://example.com/mask.png",
    speed: "fast"
  };

  const headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  };

  fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(payload)
  })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
  )

  func main() {
      url := "https://gccai.heqingsong.uk/v1/midjourney/generations/modal"

      payload := map[string]interface{}{
          "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
          "prompt": "replace the selected area with a red leather sofa",
          "mask_url": "https://example.com/mask.png",
          "speed": "fast",
      }

      jsonData, _ := json.Marshal(payload)

      req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
      req.Header.Set("Authorization", "Bearer <token>")
      req.Header.Set("Content-Type", "application/json")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      fmt.Println(string(body))
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal";

          String payload = """
          {
            "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
            "prompt": "replace the selected area with a red leather sofa",
            "mask_url": "https://example.com/mask.png",
            "speed": "fast"
          }
          """;

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer <token>")
              .header("Content-Type", "application/json")
              .POST(HttpRequest.BodyPublishers.ofString(payload))
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal";

  $payload = [
      "task_id" => "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
      "prompt" => "replace the selected area with a red leather sofa",
      "mask_url" => "https://example.com/mask.png",
      "speed" => "fast",
  ];

  $ch = curl_init($url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer <token>",
      "Content-Type: application/json"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  url = URI("https://gccai.heqingsong.uk/v1/midjourney/generations/modal")

  payload = {
    task_id: "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
    prompt: "replace the selected area with a red leather sofa",
    mask_url: "https://example.com/mask.png",
    speed: "fast",
  }

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(url)
  request["Authorization"] = "Bearer <token>"
  request["Content-Type"] = "application/json"
  request.body = payload.to_json

  response = http.request(request)
  puts response.body
  ```

  ```swift Swift theme={null}
  import Foundation

  let url = URL(string: "https://gccai.heqingsong.uk/v1/midjourney/generations/modal")!

  let payload: [String: Any] = [
      "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
      "prompt": "replace the selected area with a red leather sofa",
      "mask_url": "https://example.com/mask.png",
      "speed": "fast",
  ]

  var request = URLRequest(url: url)
  request.httpMethod = "POST"
  request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
  request.setValue("application/json", forHTTPHeaderField: "Content-Type")
  request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }
      
      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal";

          var payload = @"{
              ""task_id"": ""task_01KQW1N9T6E3AHW6QZFDEK8M5C"",
              ""prompt"": ""replace the selected area with a red leather sofa"",
              ""mask_url"": ""https://example.com/mask.png"",
              ""speed"": ""fast""
          }";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

          var content = new StringContent(payload, Encoding.UTF8, "application/json");
          var response = await client.PostAsync(url, content);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```

  ```c C theme={null}
  #include <stdio.h>
  #include <curl/curl.h>

  int main(void) {
      CURL *curl;
      CURLcode res;

      curl_global_init(CURL_GLOBAL_DEFAULT);
      curl = curl_easy_init();

      if(curl) {
          const char *url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal";
          const char *payload = "{"
              "\"task_id\":\"task_01KQW1N9T6E3AHW6QZFDEK8M5C\","
              "\"prompt\":\"replace the selected area with a red leather sofa\","
              "\"mask_url\":\"https://example.com/mask.png\","
              "\"speed\":\"fast\""
          "}";

          struct curl_slist *headers = NULL;
          headers = curl_slist_append(headers, "Authorization: Bearer <token>");
          headers = curl_slist_append(headers, "Content-Type: application/json");

          curl_easy_setopt(curl, CURLOPT_URL, url);
          curl_easy_setopt(curl, CURLOPT_POSTFIELDS, payload);
          curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

          res = curl_easy_perform(curl);

          if(res != CURLE_OK) {
              fprintf(stderr, "curl_easy_perform() failed: %s\n",
                      curl_easy_strerror(res));
          }

          curl_slist_free_all(headers);
          curl_easy_cleanup(curl);
      }

      curl_global_cleanup();
      return 0;
  }
  ```

  ```objectivec Objective-C theme={null}
  #import <Foundation/Foundation.h>

  int main(int argc, const char * argv[]) {
      @autoreleasepool {
          NSURL *url = [NSURL URLWithString:@"https://gccai.heqingsong.uk/v1/midjourney/generations/modal"];
          
          NSDictionary *payload = @{
              @"task_id": @"task_01KQW1N9T6E3AHW6QZFDEK8M5C",
              @"prompt": @"replace the selected area with a red leather sofa",
              @"mask_url": @"https://example.com/mask.png",
              @"speed": @"fast",
          };
          
          NSError *error;
          NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payload
                                                            options:0
                                                              error:&error];
          
          NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
          [request setHTTPMethod:@"POST"];
          [request setValue:@"Bearer <token>" forHTTPHeaderField:@"Authorization"];
          [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
          [request setHTTPBody:jsonData];
          
          NSURLSessionDataTask *task = [[NSURLSession sharedSession] 
              dataTaskWithRequest:request
              completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                  if (error) {
                      NSLog(@"Error: %@", error);
                      return;
                  }
                  NSString *result = [[NSString alloc] initWithData:data 
                                                          encoding:NSUTF8StringEncoding];
                  NSLog(@"%@", result);
              }];
          
          [task resume];
          [[NSRunLoop mainRunLoop] run];
      }
      return 0;
  }
  ```

  ```ocaml OCaml theme={null}
  (* Requires cohttp and yojson libraries *)
  open Lwt
  open Cohttp
  open Cohttp_lwt_unix

  let url = "https://gccai.heqingsong.uk/v1/midjourney/generations/modal"

  let payload = {|{
    "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
    "prompt": "replace the selected area with a red leather sofa",
    "mask_url": "https://example.com/mask.png",
    "speed": "fast"
  }|}

  let () =
    let headers = Header.init ()
      |> fun h -> Header.add h "Authorization" "Bearer <token>"
      |> fun h -> Header.add h "Content-Type" "application/json"
    in
    let body = Cohttp_lwt.Body.of_string payload in
    
    let response = Client.post ~headers ~body (Uri.of_string url) >>= fun (resp, body) ->
      body |> Cohttp_lwt.Body.to_string >|= fun body_str ->
      print_endline body_str
    in
    Lwt_main.run response
  ```

  ```dart Dart theme={null}
  import 'dart:convert';
  import 'package:http/http.dart' as http;

  void main() async {
    final url = Uri.parse('https://gccai.heqingsong.uk/v1/midjourney/generations/modal');
    
    final payload = {
      'task_id': 'task_01KQW1N9T6E3AHW6QZFDEK8M5C',
      'prompt': 'replace the selected area with a red leather sofa',
      'mask_url': 'https://example.com/mask.png',
      'speed': 'fast',
    };
    
    final response = await http.post(
      url,
      headers: {
        'Authorization': 'Bearer <token>',
        'Content-Type': 'application/json',
      },
      body: jsonEncode(payload),
    );
    
    print(response.body);
  }
  ```

  ```r R theme={null}
  library(httr)
  library(jsonlite)

  url <- "https://gccai.heqingsong.uk/v1/midjourney/generations/modal"

  payload <- list(
    task_id = "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
    prompt = "replace the selected area with a red leather sofa",
    mask_url = "https://example.com/mask.png",
    speed = "fast"
  )

  response <- POST(
    url,
    add_headers(
      Authorization = "Bearer <token>",
      `Content-Type` = "application/json"
    ),
    body = toJSON(payload, auto_unbox = TRUE),
    encode = "raw"
  )

  cat(content(response, "text"))
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": [
      {
        "status": "submitted",
        "task_id": "task_01KV52C0TEJSYZMCG0NCS4YWKK"
      }
    ]
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "code": 400,
      "message": "请求参数无效",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "身份验证失败，请检查您的API密钥",
      "type": "authentication_error"
    }
  }
  ```

  ```json 402 theme={null}
  {
    "error": {
      "code": 402,
      "message": "账户余额不足，请充值后再试",
      "type": "payment_required"
    }
  }
  ```

  ```json 403 theme={null}
  {
    "error": {
      "code": 403,
      "message": "访问被禁止，您没有权限访问此资源",
      "type": "permission_error"
    }
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "code": 404,
      "message": "任务不存在",
      "type": "not_found_error"
    }
  }
  ```

  ```json 422 theme={null}
  {
    "error": {
      "code": 422,
      "message": "图片或提示词未通过内容审核，已自动退款",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "请求过于频繁，请稍后再试",
      "type": "rate_limit_error"
    }
  }
  ```

  ```json 500 theme={null}
  {
    "error": {
      "code": 500,
      "message": "服务器内部错误，请稍后重试",
      "type": "server_error"
    }
  }
  ```

  ```json 502 theme={null}
  {
    "error": {
      "code": 502,
      "message": "网关错误，服务器暂时不可用",
      "type": "bad_gateway"
    }
  }
  ```
</ResponseExample>

给 MODAL 状态的局部重绘任务补充 mask + prompt 完成重绘。系统按 `mask_url` 是否存在自动判断模式：**有 `mask_url` → 局部重绘；无 → 外扩**。

| 项目     | 内容                                     |
| ------ | -------------------------------------- |
| action | `MODAL`                                |
| 计费     | `midjourney@modal[-speed]`             |
| 必填     | `task_id`                              |
| 可选     | `prompt`、`mask_url`、`speed`、`metadata` |

## 参数

| 字段         | 说明                                                 |
| ---------- | -------------------------------------------------- |
| `task_id`  | [inpaint](./inpaint) 步骤返回的本地任务 ID（须为 MODAL 状态）     |
| `prompt`   | 局部重绘提示词；留空则继承父任务 prompt                            |
| `mask_url` | 遮罩图 URL 或 base64；**局部重绘时必填**。白色区域=要重绘的位置，透明区域=保留原图 |
| `speed`    | `relax` / `fast` / `turbo`                         |
| `metadata` | 可选                                                 |

## mask 要求

| 项    | 建议                                        |
| ---- | ----------------------------------------- |
| 格式   | PNG 透明背景（也支持 `data:image/png;base64,...`） |
| 分辨率  | 建议与父图同分辨率（系统也会自动 resize）                  |
| 白色区域 | 要重绘的位置；透明区域保留原图                           |
| 大小   | 单图 ≤ 12 MiB                               |
| URL  | 必须公网可达（私网会被 SSRF 拦截）                      |

## 请求示例

```json theme={null}
{
  "task_id": "task_01KQW1N9T6E3AHW6QZFDEK8M5C",
  "prompt": "replace the selected area with a red leather sofa",
  "mask_url": "https://example.com/mask.png",
  "speed": "fast"
}
```

## 返回

`task_id` 不变（同一任务），status 从 `MODAL` → `SUBMITTED`。轮询 `GET /v1/tasks/{task_id}`，SUCCESS 后 `image_urls` 含 4 张局部重绘候选。计费在本接口 SUCCESS 时结算，与 inpaint 阶段不重复扣费。

如需区分速度价格，可配置 `midjourney@modal-fast` / `midjourney@modal-turbo`。