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

# Imagine (text-to-image)

> Midjourney text-to-image / image-guided generation. The default entry /v1/midjourney/generations and the explicit /imagine entry behave the same

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://gccai.heqingsong.uk/v1/midjourney/generations \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "prompt": "a beautiful sunset over mountains",
      "size": "16:9",
      "version": "6.1",
      "speed": "fast"
    }'
  ```

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

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

  payload = {
      "prompt": "a beautiful sunset over mountains",
      "size": "16:9",
      "version": "6.1",
      "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";

  const payload = {
    prompt: "a beautiful sunset over mountains",
    size: "16:9",
    version: "6.1",
    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"

      payload := map[string]interface{}{
          "prompt": "a beautiful sunset over mountains",
          "size": "16:9",
          "version": "6.1",
          "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";

          String payload = """
          {
            "prompt": "a beautiful sunset over mountains",
            "size": "16:9",
            "version": "6.1",
            "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";

  $payload = [
      "prompt" => "a beautiful sunset over mountains",
      "size" => "16:9",
      "version" => "6.1",
      "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")

  payload = {
    prompt: "a beautiful sunset over mountains",
    size: "16:9",
    version: "6.1",
    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")!

  let payload: [String: Any] = [
      "prompt": "a beautiful sunset over mountains",
      "size": "16:9",
      "version": "6.1",
      "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";

          var payload = @"{
              ""prompt"": ""a beautiful sunset over mountains"",
              ""size"": ""16:9"",
              ""version"": ""6.1"",
              ""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";
          const char *payload = "{"
              "\"prompt\":\"a beautiful sunset over mountains\","
              "\"size\":\"16:9\","
              "\"version\":\"6.1\","
              "\"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"];
          
          NSDictionary *payload = @{
              @"prompt": @"a beautiful sunset over mountains",
              @"size": @"16:9",
              @"version": @"6.1",
              @"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"

  let payload = {|{
    "prompt": "a beautiful sunset over mountains",
    "size": "16:9",
    "version": "6.1",
    "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');
    
    final payload = {
      'prompt': 'a beautiful sunset over mountains',
      'size': '16:9',
      'version': '6.1',
      '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"

  payload <- list(
    prompt = "a beautiful sunset over mountains",
    size = "16:9",
    version = "6.1",
    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": "Invalid request parameters",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "Invalid authentication credentials",
      "type": "authentication_error"
    }
  }
  ```

  ```json 402 theme={null}
  {
    "error": {
      "code": 402,
      "message": "Insufficient balance. Please top up your account",
      "type": "payment_required"
    }
  }
  ```

  ```json 403 theme={null}
  {
    "error": {
      "code": 403,
      "message": "Access forbidden. You don't have permission to access this resource",
      "type": "permission_error"
    }
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "code": 404,
      "message": "Task not found",
      "type": "not_found_error"
    }
  }
  ```

  ```json 422 theme={null}
  {
    "error": {
      "code": 422,
      "message": "Image or prompt failed content moderation; automatically refunded",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "Rate limit exceeded. Please try again later",
      "type": "rate_limit_error"
    }
  }
  ```

  ```json 500 theme={null}
  {
    "error": {
      "code": 500,
      "message": "Internal server error. Please try again later",
      "type": "server_error"
    }
  }
  ```

  ```json 502 theme={null}
  {
    "error": {
      "code": 502,
      "message": "Bad gateway. The server is temporarily unavailable",
      "type": "bad_gateway"
    }
  }
  ```
</ResponseExample>

Default text-to-image / image-guided endpoint, equivalent to `imagine`. The explicit `/v1/midjourney/generations/imagine` endpoint behaves the same way.

| Item     | Value                                            |
| -------- | ------------------------------------------------ |
| action   | `IMAGINE`                                        |
| Billing  | `midjourney@imagine[-version][-speed]`           |
| Required | `prompt`                                         |
| Optional | `image_urls`, prompt fields, `speed`, `metadata` |

## Request body

| Field        | Type      | Required | Notes                                                          |
| ------------ | --------- | -------- | -------------------------------------------------------------- |
| `prompt`     | string    | Yes      | Prompt; native MJ flags allowed (e.g. `--ar 16:9 --v 6.1`)     |
| `speed`      | string    | No       | `relax` (default) / `fast` / `turbo`                           |
| `image_urls` | string\[] | No       | Image URLs or base64 for image-guided generation               |
| `metadata`   | object    | No       | Custom metadata saved with the task for business-side tracking |

### Structured fields (optional)

You can set these in the JSON body or in `prompt` (e.g. `--ar 16:9`). **Body values override prompt.**

| Field             | Type   | MJ equivalent | Notes                                                                                                                               |
| ----------------- | ------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `size`            | string | `--ar`        | e.g. `"16:9"`, `"1:1"`, `"9:16"`                                                                                                    |
| `quality`         | string | `--q`         | `"0.25"`, `"0.5"`, `"1"`, `"2"`                                                                                                     |
| `style`           | string | `--style`     | e.g. `"raw"`                                                                                                                        |
| `version`         | string | `--v`         | Version. Main MJ versions append `--v <version>`; when used with `niji: true` and `"7"` / `"6"`, it is normalized as a Niji version |
| `seed`            | int    | `--seed`      | Seed                                                                                                                                |
| `negative_prompt` | string | `--no`        | e.g. `"ugly, blurry"`                                                                                                               |
| `stylize`         | int    | `--s`         | 0–1000                                                                                                                              |
| `chaos`           | int    | `--c`         | 0–100                                                                                                                               |
| `weird`           | int    | `--w`         | 0–3000                                                                                                                              |
| `tile`            | bool   | `--tile`      | Tile mode                                                                                                                           |
| `niji`            | bool   | `--niji`      | Niji switch. Recommended: `niji: true` + `version: "7"` / `"6"`                                                                     |
| `iw`              | float  | `--iw`        | 0–3, image weight                                                                                                                   |
| `cw`              | int    | `--cw`        | 0–100                                                                                                                               |
| `sw`              | int    | `--sw`        | 0–1000                                                                                                                              |
| `cref`            | string | `--cref`      | Character ref URL                                                                                                                   |
| `sref`            | string | `--sref`      | Style ref URL                                                                                                                       |
| `dref`            | string | `--dref`      | Depth reference image URL                                                                                                           |
| `dw`              | float  | `--dw`        | Depth weight (0–100)                                                                                                                |
| `repeat`          | int    | `--repeat`    | 2–40                                                                                                                                |
| `raw`             | bool   | `--raw`       | Raw style (v5.1+)                                                                                                                   |
| `draft`           | bool   | `--draft`     | Draft mode (v7+)                                                                                                                    |
| `hd`              | bool   | `--hd`        | HD mode (v8.1 / v8.2 only; backend auto-injects `--v 8.1` when `version` is unspecified)                                            |
| `stop`            | int    | `--stop`      | Early stop (10–100; v5–6.1 / niji 5–6 only)                                                                                         |
| `extra`           | string | any `--xxx`   | Escape hatch; appended to prompt verbatim                                                                                           |

## Examples

**All flags in prompt**

```json theme={null}
{
  "prompt": "a beautiful sunset over mountains --ar 16:9 --v 6.1 --style raw --s 750"
}
```

**Structured body (recommended)**

```json theme={null}
{
  "prompt": "a beautiful sunset over mountains",
  "size": "16:9",
  "version": "6.1",
  "style": "raw",
  "stylize": 750
}
```

**Main versions and Niji versions**

```json theme={null}
{
  "prompt": "anime girl in a moonlit garden",
  "niji": true,
  "version": "7",
  "size": "9:16"
}
```

> Verified online versions: `8.2`, `8.1`, `7`, `6.1`, `5.2`, `5.1`, `niji 7`, and `niji 6`. Use body field `version` for main MJ versions. For Niji, use `niji: true` + `version: "7"` / `"6"`; the billing version is normalized to `niji7` / `niji6`.

**Mixed (body wins)**

```json theme={null}
{
  "prompt": "a beautiful sunset --ar 1:1",
  "size": "16:9"
}
```

> Final prompt: `a beautiful sunset --ar 16:9` (`size` in body overrides `--ar 1:1` in prompt.)

**Image-guided**

```json theme={null}
{
  "prompt": "turn this product into a luxury studio photo",
  "image_urls": ["https://example.com/product.png"],
  "size": "1:1",
  "iw": 1.2
}
```

**Fast mode**

```json theme={null}
{
  "prompt": "a cute cat",
  "speed": "fast"
}
```

> `speed=relax` or omitted `speed` does not add a billing speed suffix. `fast` / `turbo` are applied through the corresponding speed routes and match the corresponding billing keys.

## Response

```json theme={null}
{
  "code": 200,
  "data": [{
    "status": "submitted",
    "task_id": "task_01JWXXXXXXXXXXXX"
  }]
}
```

After submission, poll the result via [Get task](./query).