> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Qwen Image 3.0 with Comfy Router

> Call qwen/qwen-image-3.0 through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `qwen/qwen-image-3.0`, served by Comfy Router from Qwen.

## Quick start

Create a key at [platform.comfy.org/profile/api-keys](https://platform.comfy.org/profile/api-keys) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk`, `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `qwen/qwen-image-3.0`

**Endpoint:** `POST https://api.comfy.org/v2/models/qwen/qwen-image-3.0`

<CodeGroup>
  ```python Python theme={null}
  from comfy_sdk import Comfy

  # Reads COMFY_API_KEY from the environment. Each call sends a fresh
  # Idempotency-Key and waits up to 10 minutes for the finished result.
  with Comfy() as client:
      result = client.models.run(
          "qwen/qwen-image-3.0",
          {
              "input": {
                  "messages": [
                      {
                          "content": [
                              {
                                  "text": "A single red maple leaf on a plain white background.",
                              },
                          ],
                          "role": "user",
                      },
                  ],
              },
          },
      )

  print(result)
  ```

  ```typescript TypeScript theme={null}
  import { comfy } from "@comfyorg/sdk";

  // Reads COMFY_API_KEY from the environment. Each call sends a fresh
  // Idempotency-Key and waits up to 10 minutes for the finished result.
  const { data } = await comfy.models.run("qwen/qwen-image-3.0", {
    input: {
      messages: [
        {
          content: [
            {
              text: "A single red maple leaf on a plain white background.",
            },
          ],
          role: "user",
        },
      ],
    },
  });

  console.log(data);
  ```

  ```bash cURL theme={null}
  curl https://api.comfy.org/v2/models/qwen/qwen-image-3.0 \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $(uuidgen)" \
    -H "Content-Type: application/json" \
    -d "{\"input\": {\"messages\":[{\"content\":[{\"text\":\"A single red maple leaf on a plain white background.\"}],\"role\":\"user\"}]}}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="input" type="object" required>
  The input parameter object containing the request messages
</ParamField>

<ParamField body="input.messages" type="object[]" required>
  The request content array. Only single-round conversations are supported, so the array must contain exactly one object
</ParamField>

<ParamField body="input.messages[].content" type="object[]" required>
  The message content array. Text-to-image contains one text object; image editing contains 1-3 image objects and one text object
</ParamField>

<ParamField body="input.messages[].content[].image" type="string">
  The URL or Base64 encoded data of an input image. 1-3 images are supported for image editing
</ParamField>

<ParamField body="input.messages[].content[].text" type="string">
  The positive prompt that describes the image content, style, and composition to generate or edit
</ParamField>

<ParamField body="input.messages[].role" type="string" required>
  The role of the message sender. Must be set to user

  Possible values: `user`
</ParamField>

<ParamField body="model" type="string">
  The ID of the model to call for multimodal image generation and editing. Available values are qwen-image-3.0-pro and qwen-image-3.0. It is NOT in this schema's `required` list because Comfy Router fills it from the `{model}` path segment of /v2/models/qwen/\{model}, so a Router caller omits it; a direct v1 call to the /proxy/ route must supply it.
</ParamField>

<ParamField body="parameters" type="object">
  Additional parameters to control image generation
</ParamField>

<ParamField body="parameters.n" type="integer" default="1">
  The number of output images. Range 1-6, default is 1

  Range: `1` to `6`
</ParamField>

<ParamField body="parameters.negative_prompt" type="string">
  The negative prompt that describes content you do not want to appear in the image
</ParamField>

<ParamField body="parameters.prompt_extend" type="boolean" default="true">
  Whether to enable intelligent prompt rewriting. Default is true
</ParamField>

<ParamField body="parameters.prompt_extend_mode" type="string" default="&#x22;direct&#x22;">
  The prompt rewriting method, direct (default, supported for T2I and I2I) or agent (T2I only)

  Possible values: `direct`, `agent`
</ParamField>

<ParamField body="parameters.seed" type="integer">
  Random number seed to control randomness. Range \[0, 2147483647]

  Range: `0` to `2147483647`
</ParamField>

<ParamField body="parameters.size" type="string">
  The output image resolution in the format width*height, for example 1024*1024. The API accepts a pixel area between 262144 (512*512) and 6553600 (2560*2560) with an aspect ratio between 1:8 and 8:1. If not specified, the model automatically recommends a resolution based on the prompt
</ParamField>

<ParamField body="parameters.watermark" type="boolean" default="false">
  Whether to add a watermark. Default is false
</ParamField>

Generated from the schema Router serves at `GET /v2/models/qwen/qwen-image-3.0/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

<ResponseField name="code" type="string">
  The error code for the failed request (not returned if request is successful)
</ResponseField>

<ResponseField name="message" type="string">
  Detailed information about the failed request (not returned if request is successful)
</ResponseField>

<ResponseField name="output" type="object">
  Contains the model generation results
</ResponseField>

<ResponseField name="output.choices" type="object[]">
  The list of result options
</ResponseField>

<ResponseField name="output.choices[].finish_reason" type="string">
  The reason why the task stopped. The value is stop when the task completes normally
</ResponseField>

<ResponseField name="output.choices[].message" type="object">
  The message returned by the model
</ResponseField>

<ResponseField name="output.choices[].message.content" type="object[]">
  The message content containing the generated image information
</ResponseField>

<ResponseField name="output.choices[].message.content[].image" type="string">
  The URL of the generated image in PNG format. The link is valid for 24 hours
</ResponseField>

<ResponseField name="output.choices[].message.content[].text" type="string">
  A textual element returned in place of an image. An element carrying only this field produced NO asset, so a caller keys completion off `image` rather than off the presence of a content element
</ResponseField>

<ResponseField name="output.choices[].message.role" type="string">
  The role of the message. Fixed as assistant
</ResponseField>

<ResponseField name="request_id" type="string">
  Unique request identifier
</ResponseField>

<ResponseField name="usage" type="object">
  The resource usage of this call. Only returned on success
</ResponseField>

<ResponseField name="usage.input_image_count" type="integer">
  The number of input images in the request. Returns 0 for text-to-image
</ResponseField>

<ResponseField name="usage.input_image_type" type="string">
  The input image billing tier, qima\_input\_1k or qima\_input\_2k, determined by the output resolution pixel area
</ResponseField>

<ResponseField name="usage.output_height" type="integer">
  The height of the final output image in pixels
</ResponseField>

<ResponseField name="usage.output_image_count" type="integer">
  The actual number of output images returned
</ResponseField>

<ResponseField name="usage.output_image_type" type="string">
  The output image billing tier, qima\_output\_1k or qima\_output\_2k, determined by the output resolution pixel area
</ResponseField>

<ResponseField name="usage.output_width" type="integer">
  The width of the final output image in pixels
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "input": {
    "messages": [
      {
        "content": [
          {
            "text": "A single red maple leaf on a plain white background."
          }
        ],
        "role": "user"
      }
    ]
  }
}
```

### Output

```json theme={null}
{
  "output": {
    "choices": [
      {
        "finish_reason": "stop",
        "message": {
          "content": [
            {
              "image": "https://example.invalid/qwen/generated.png"
            }
          ],
          "role": "assistant"
        }
      }
    ]
  },
  "request_id": "9f2c1b3a-5d4e-4a67-8b90-1c2d3e4f5a6b",
  "usage": {
    "input_image_count": 0,
    "output_height": 512,
    "output_image_count": 1,
    "output_image_type": "qima_output_1k",
    "output_width": 512
  }
}
```

## Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the [Comfy Router headers](/development/comfy-router/headers) page: send an `Idempotency-Key` on every paid call and reuse it when you retry, expect the connection to be held up to Router's 10 minute deadline, and keep `X-Comfy-Request-Id` from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, `X-Comfy-Error-Type` names the bucket, and a `422` means the body failed the model's schema and was never billed.

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Quick Start" icon="rocket" href="/development/comfy-router/quickstart">
    Typed error handling in Python and TypeScript, reading the 422, walking the catalog.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>