# ControlNet SDXL

> Generate Images with ControlNet.


## Overview

- **Endpoint**: `https://fal.run/fal-ai/fast-sdxl-controlnet-canny`
- **Model ID**: `fal-ai/fast-sdxl-controlnet-canny`
- **Category**: text-to-image
- **Kind**: inference
**Tags**: diffusion, controlnet, manipulation



## Pricing

- **Price**: $0 per compute seconds

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`prompt`** (`string`, _required_):
  The prompt to use for generating the image. Be as descriptive as possible for best results.
  - Examples: "Ice fortress, aurora skies, polar wildlife, twilight"

- **`control_image_url`** (`string`, _required_):
  The URL of the control image.
  - Examples: "https://avatars.githubusercontent.com/u/74778219"

- **`controlnet_conditioning_scale`** (`float`, _optional_):
  The scale of the controlnet conditioning. Default value: `0.5`
  - Default: `0.5`
  - Range: `0` to `1`

- **`negative_prompt`** (`string`, _optional_):
  The negative prompt to use. Use it to address details that you don't want
  in the image. This could be colors, objects, scenery and even the small details
  (e.g. moustache, blurry, low resolution). Default value: `""`
  - Default: `""`
  - Examples: "cartoon, illustration, animation. face. male, female", "ugly, deformed"

- **`image_size`** (`ImageSize | Enum`, _optional_):
  The size of the generated image. Leave it none to automatically infer from the control image.
  - One of: ImageSize | Enum

- **`num_inference_steps`** (`integer`, _optional_):
  The number of inference steps to perform. Default value: `25`
  - Default: `25`
  - Range: `1` to `50`

- **`seed`** (`integer`, _optional_):
  The same seed and the same prompt given to the same version of Stable Diffusion
  will output the same image every time.

- **`enable_deep_cache`** (`boolean`, _optional_):
  If set to true, DeepCache will be enabled. TBD
  - Default: `false`

- **`guidance_scale`** (`float`, _optional_):
  The CFG (Classifier Free Guidance) scale is a measure of how close you want
  the model to stick to your prompt when looking for a related image to show you. Default value: `7.5`
  - Default: `7.5`
  - Range: `0` to `20`

- **`sync_mode`** (`boolean`, _optional_):
  If set to true, the function will wait for the image to be generated and uploaded
  before returning the response. This will increase the latency of the function but
  it allows you to get the image directly in the response without going through the CDN.
  - Default: `false`

- **`num_images`** (`integer`, _optional_):
  The number of images to generate. Default value: `1`
  - Default: `1`
  - Range: `1` to `8`

- **`loras`** (`list<LoraWeight>`, _optional_):
  The list of LoRA weights to use.
  - Default: `[]`
  - Array of LoraWeight

- **`enable_safety_checker`** (`boolean`, _optional_):
  If set to true, the safety checker will be enabled.
  - Default: `false`

- **`expand_prompt`** (`boolean`, _optional_):
  If set to true, the prompt will be expanded with additional prompts.
  - Default: `false`



**Required Parameters Example**:

```json
{
  "prompt": "Ice fortress, aurora skies, polar wildlife, twilight",
  "control_image_url": "https://avatars.githubusercontent.com/u/74778219"
}
```

**Full Example**:

```json
{
  "prompt": "Ice fortress, aurora skies, polar wildlife, twilight",
  "control_image_url": "https://avatars.githubusercontent.com/u/74778219",
  "controlnet_conditioning_scale": 0.5,
  "negative_prompt": "cartoon, illustration, animation. face. male, female",
  "num_inference_steps": 25,
  "guidance_scale": 7.5,
  "num_images": 1,
  "loras": []
}
```


### Output Schema

The API returns the following output format:

- **`images`** (`list<Image>`, _required_):
  The generated image files info.
  - Array of Image

- **`timings`** (`Timings`, _required_)

- **`seed`** (`integer`, _required_):
  Seed of the generated Image. It will be the same value of the one passed in the
  input or the randomly generated that was used in case none was passed.

- **`has_nsfw_concepts`** (`list<boolean>`, _required_):
  Whether the generated images contain NSFW concepts.
  - Array of boolean



**Example Response**:

```json
{
  "images": [
    {
      "url": "",
      "content_type": "image/jpeg"
    }
  ]
}
```


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/fast-sdxl-controlnet-canny \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "prompt": "Ice fortress, aurora skies, polar wildlife, twilight",
     "control_image_url": "https://avatars.githubusercontent.com/u/74778219"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/fast-sdxl-controlnet-canny",
    arguments={
        "prompt": "Ice fortress, aurora skies, polar wildlife, twilight",
        "control_image_url": "https://avatars.githubusercontent.com/u/74778219"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

```javascript
import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/fast-sdxl-controlnet-canny", {
  input: {
    prompt: "Ice fortress, aurora skies, polar wildlife, twilight",
    control_image_url: "https://avatars.githubusercontent.com/u/74778219"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/fal-ai/fast-sdxl-controlnet-canny)
- [API Documentation](https://fal.ai/models/fal-ai/fast-sdxl-controlnet-canny/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/fast-sdxl-controlnet-canny)

### fal.ai Platform

- [Platform Documentation](https://docs.fal.ai)
- [Python Client](https://docs.fal.ai/clients/python)
- [JavaScript Client](https://docs.fal.ai/clients/javascript)