Cerebrium home pagelight logo
Image Models
ControlNet

In order to deploy the model you can use the identifier below:

  • ControlNet: controlnet

ControlNet provides a minimal interface allowing users to customize the generation process up to a great extent. With ControlNet, users can easily condition the generation with different spatial contexts such as a depth map, a segmentation map, a scribble, keypoints, and so on! We also provide support for custom Dreambooth models that are hosted on Hugging Face. You can follow this example of how to call the deployed endpoint:

​
Request Parameters

  curl --location --request POST 'https://run.cerebrium.ai/controlnet-webhook/predict' \
      --header 'Authorization: <API_KEY>' \
      --header 'Content-Type: application/json' \
      --data-raw '{
        "prompt": "a photo of an astronaut riding a horse on mars.",
        "model": "canny",
        "image": "<BASE_64_STRING>",
        "file_url": "https://your-url.com/image.png"
        "hf_token": "<your_token>",
        "model_id": "<your_id>",
        "height": 512,
        "width": 512,
        "num_inference_steps": 50,
        "guidance_scale": 7.5,
        "num_images_per_prompt": 1,
        "negative_prompt": "",
        "seed": 120,
        "low_threshold": 100,
        "high_threshold": 200,
        "webhook_endpoint": "https://your-url.com"
      }'
Authorizationrequired
string

This is the Cerebrium API key used to authenticate your request. You can get it from your Cerebrium dashboard.

promptrequired
string

The prompt you would like the Controlnet model to generate.

modelrequired
string

The type of model you would like to run. We currently support the following:

  • Canny Edge detection - “canny”
  • Open Pose - “openpose”
  • Depth Estimation - “depth”
  • HED edge detection - “hed”
  • MLSD line detection - “mlsd”
  • Trained with normal map - “normal”
  • human scribbles - “scribble”
  • semantic segmentation - “seg”
imageoptional
string

A base64 encoded string of your image. We only recommend this if the image is small otherwise use the file_url.

file_urloptional
string

A publicly accessible url to download your image

hf_tokenoptional
string

This is the token from your HuggingFace profile in order to access your model repo. This is a required parameter if you enter a model id that is private.

model_idoptional
string

This is the Hugging Face id of your model repo. If nothing is provided we use the Stable diffusion base model.

heightoptional
integer

The height of the generated image which defaults to 512px. This is an optional parameter

widthoptional
integer

The width of the generated image which defaults to 512px. This is an optional parameter

num_inference_stepsoptional
integer

The number of steps you would like Dreambooth to take to generate the image. In general, the results are better the more steps you use, however the more steps, the longer the generation takes. It defaults to 50 steps and is an optional parameter.

guidance_scaleoptional
float

A way to increase the adherence to the conditional signal that guides the generation (text, in this case) as well as overall sample quality. In simple terms it forces the generation to better match the prompt potentially at the cost of image quality or diversity. This defaults to 7.5 and is an optional parameter.

num_images_per_promptoptional
integer

The number of image variations you would like the model to generate. This is an optional parameter which defaults to 1.

negative_promptoptional
string

The negative prompt is a parameter that tells Stable Diffusion what you don’t want to see in the generated images. This is an optional parameter that has an empty default value.

seedoptional
integer

Make sure that generations are the exact same for the same prompts

low_thresholdoptional
integer

This is the low threshold for the Canny Edge model. It can have a value between 1 and 255.

high_thresholdoptional
integer

This is the high threshold for the Canny Edge model. It can have a value between 1 and 255.

webhook_endpointoptional
string

The url endpoint you would like us to send the image results to once it has finished generating

{
    "run_id": "<UUID_STRING>",
    "message": "Successfully generated images",
    "run_time_ms": 15404
    "result": [<BASE_64_STRING>]
}

​
Response Parameters

run_idrequired
string

A unique identifier for the run that you can use to associate prompts with webhook endpoints.

messagerequired
string

Whether of not the response was successful

run_time_msrequired
string

The amount of time in millisecond it took to run your function. This is what you will be billed for.

imagesrequired
string

An array of base64 encoded strings of the image that you can convert into an image