import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/control/sketch",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./sketch.png", "rb")
    },
    data={
        "prompt": "a medieval castle on a hill",
        "control_strength": 0.7,
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./castle.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated jpeg"

Control

Sketch

This service offers an ideal solution for design projects that require brainstorming and frequent iterations. It upgrades rough hand-drawn sketches to refined outputs with precise control. For non-sketch images, it allows detailed manipulation of the final appearance by leveraging the contour lines and edges within the image.

Try it out

Grab your API key and head over to

How to use

Please invoke this endpoint with a POST request.

The headers of the request must include an API key in the authorization field. The body of the request must be multipart/form-data, and the accept header should be set to one of the following:

image/* to receive the image in the format specified by the output_format parameter.
application/json to receive the image encoded as base64 in a JSON response.

The body of the request should include:

image
prompt

The body may optionally include:

control_strength
negative_prompt
seed
output_format
style_preset

Note: for more details about these parameters please see the request schema below.

Output

The resolution of the generated image will match that of the input image.

Credits

Flat rate of 5 credits per successful generation. You will not be charged for failed generations.

POST

v2beta

stable-image

control

sketch

import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/control/sketch",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./sketch.png", "rb")
    },
    data={
        "prompt": "a medieval castle on a hill",
        "control_strength": 0.7,
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./castle.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated jpeg"

Authorizations

authorization

string

header

required

Use your Stability API key to authentication requests to this App.

Headers

authorization

string

required

Your Stability API key, used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.

Minimum string length: 1

content-type

string

required

The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.

Minimum string length: 1

Example:

"multipart/form-data"

enum<string>

default:image/*

Specify image/* to receive the bytes of the image directly. Otherwise specify application/json to receive the image as base64 encoded JSON.

Available options:

image/*,

application/json

stability-client-id

string

The name of your application, used to help us communicate app-specific debugging or moderation issues to you.

Maximum string length: 256

Example:

"my-awesome-app"

stability-client-user-id

string

A unique identifier for your end user. Used to help us communicate user-specific debugging or moderation issues to you. Feel free to obfuscate this value to protect user privacy.

Maximum string length: 256

Example:

"DiscordUser#9999"

stability-client-version

string

The version of your application, used to help us communicate version-specific debugging or moderation issues to you.

Maximum string length: 256

Example:

"1.2.1"

Body

multipart/form-data

prompt

string

required

What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results.

To control the weight of a given word use the format (word:weight), where word is the word you'd like to control the weight of and weight is a value between 0 and 1. For example: The sky was a crisp (blue:0.3) and (green:0.8) would convey a sky that was blue and green, but more green than blue.

Required string length: 1 - 10000

image

file

required

Supported Formats:

jpeg
png
webp

Image Dimensions:

Every side must be at least 64 pixels
The total pixel count cannot exceed 9,437,184 pixels (e.g. 3072x3072, 4096x2304, etc.)

Image Aspect Ratio:

Must be between 1:2.5 and 2.5:1 (i.e. cannot be too tall or too wide)

control_strength

number

default:0.7

How much influence, or control, the image has on the generation. Represented as a float between 0 and 1, where 0 is the least influence and 1 is the maximum.

Required range: 0 <= x <= 1

negative_prompt

string

A blurb of text describing what you do not wish to see in the output image. This is an advanced feature.

Maximum string length: 10000

seed

number

default:0

A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)

Required range: 0 <= x <= 4294967294

output_format

enum<string>

default:png

Dictates the content-type of the generated image.

Available options:

png,

jpeg,

webp

style_preset

enum<string>

Guides the image model towards a particular style.

Available options:

enhance,

anime,

photographic,

digital-art,

comic-book,

fantasy-art,

line-art,

analog-film,

neon-punk,

isometric,

low-poly,

origami,

modeling-compound,

cinematic,

3d-model,

pixel-art,

tile-texture

Response

Generation was successful.

The bytes of the generated image.

The finish-reason and seed will be present as headers.