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

# Use Krea 3 with Comfy Router

> Call krea/krea-3 through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `krea/krea-3`, served by Comfy Router from Krea.

**Input:** Text, Image · **Output:** Image

## Quick start

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

**Model ID:** `krea/krea-3`

**Endpoint:** `POST https://api.comfy.org/v2/models/krea/krea-3`

<Tabs defaultTabIndex={1}>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "krea/krea-3",
              {
                  "image_urls": ["https://example.com/reference.png"],
                  "prompt": "Place the product on a clean studio background",
                  "resolution": "1k",
              },
          )

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("krea/krea-3", {
        image_urls: ["https://example.com/reference.png"],
        prompt: "Place the product on a clean studio background",
        resolution: "1k",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/krea/krea-3 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_urls\": [\"https://example.com/reference.png\"], \"prompt\": \"Place the product on a clean studio background\", \"resolution\": \"1k\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    The same body, sent to `POST https://api.comfy.org/v2/models/krea/krea-3/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

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

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      async def main():
          async with AsyncComfy() as client:
              handle = await client.models.submit(
                  "krea/krea-3",
                  {
                      "image_urls": ["https://example.com/reference.png"],
                      "prompt": "Place the product on a clean studio background",
                      "resolution": "1k",
                  },
              )
              print("request_id:", handle.request_id)  # with the model ID, all another process needs

              # Poll until the request completes, waiting the Retry-After the server names.
              async for update in handle.iter_events():
                  print(update.status, update.queue_position)

              # The provider's own payload, the same value models.run() returns.
              # A request that failed or was cancelled raises the typed Router error here.
              result = await handle.get()

          print(result)

      asyncio.run(main())
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("krea/krea-3", {
        image_urls: ["https://example.com/reference.png"],
        prompt: "Place the product on a clean studio background",
        resolution: "1k",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/krea/krea-3/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_urls\": [\"https://example.com/reference.png\"], \"prompt\": \"Place the product on a clean studio background\", \"resolution\": \"1k\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/krea/krea-3/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/krea/krea-3/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="aspect_ratio" type="string">
  1:1, 4:5, 3:4, 2:3, 9:16, 5:4, 4:3, 3:2, 16:9 or 21:9. Use with resolution; omit for automatic framing.
</ParamField>

<ParamField body="image_urls" type="string[]">
  Input image URLs, up to 8. Use image\_url values from POST /proxy/krea/assets. Omit for text-to-image.
</ParamField>

<ParamField body="model" type="string">
  berry (default, quality) or jam (speed).
</ParamField>

<ParamField body="negative_prompt" type="string" />

<ParamField body="prompt" type="string" required>
  Editing instruction. Describe what should change and what should stay the same.
</ParamField>

<ParamField body="regional_edit" type="boolean">
  Set true for a local edit that keeps the rest of the image. Needs model berry and at least one image in image\_urls.
</ParamField>

<ParamField body="resolution" type="string" required>
  1k or 2k.
</ParamField>

<ParamField body="seed" type="integer" />

<ParamField body="thinking_mode" type="string">
  fast (default), high or ultra. High and ultra plan complex edits in more detail and take longer. Ultra needs resolution 2k.
</ParamField>

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

### Output

<ResponseField name="completed_at" type="string (date-time)" required>
  Format: `date-time`
</ResponseField>

<ResponseField name="created_at" type="string (date-time)" required>
  Format: `date-time`
</ResponseField>

<ResponseField name="job_id" type="string (uuid)" required>
  Format: `uuid`
</ResponseField>

<ResponseField name="result" type="object" required>
  The finished generation. Not nullable here, unlike on `KreaJob`: a terminal job whose `result` carries no `urls` is answered as a Comfy Router error, so a `200` always carries it.
</ResponseField>

<ResponseField name="result.style_id" type="string">
  Set by loraTraining jobs rather than by a generation; a `200` for these models carries `urls`.
</ResponseField>

<ResponseField name="result.urls" type="string (uri)[]" required>
  The generated images, as downloadable links. At least one, because a `completed` job with an empty `urls` is `success_without_output` and never reaches this document.
</ResponseField>

<ResponseField name="status" type="string" required>
  Always `completed` on this document: it is the only status Router reports as a success, and Krea's vocabulary is matched without a case fold.

  Possible values: `completed`
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "image_urls": [
    "https://example.com/reference.png"
  ],
  "prompt": "Place the product on a clean studio background",
  "resolution": "1k"
}
```

### Output

```json theme={null}
{
  "completed_at": "2027-01-01T00:00:37Z",
  "created_at": "2027-01-01T00:00:00Z",
  "job_id": "7f1c2e84-5b90-4a37-8d61-2c0f9ab4e153",
  "result": {
    "urls": [
      "https://example.invalid/krea/krea-2/generated.png"
    ]
  },
  "status": "completed"
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](/development/comfy-router/limitations#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](/development/api-development/sdks).

<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="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </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>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.