Skip to main content
POST
Text-to-image

Headers

Accept
enum<string>
default:application/json

The format of the response. Leave blank for JSON, or set to 'image/png' for a PNG image.

Available options:
application/json,
image/png
Organization
string

Allows for requests to be scoped to an organization other than the user's default. If not provided, the user's default organization will be used.

Stability-Client-ID
string

Used to identify the source of requests, such as the client application or sub-organization. Optional, but recommended for organizational clarity.

Stability-Client-Version
string

Used to identify the version of the application or service making the requests. Optional, but recommended for organizational clarity.

Path Parameters

engine_id
string
required

Body

application/json

Represents the optional parameters that can be passed to any generation request.

text_prompts
TextPrompts · object[]
required

An array of text prompts to use for generation.

Given a text prompt with the text A lighthouse on a cliff and a weight of 0.5, it would be represented as:

Minimum array length: 1
height
integer
default:512

Height of the image to generate, in pixels, in an increment divisible by 64.

Required range: x >= 128Must be a multiple of 64
Example:

512

width
integer
default:512

Width of the image to generate, in pixels, in an increment divisible by 64.

Required range: x >= 128Must be a multiple of 64
Example:

512

cfg_scale
number
default:7

How strictly the diffusion process adheres to the prompt text (higher values keep your image closer to your prompt)

Required range: 0 <= x <= 35
Example:

7

clip_guidance_preset
enum<string>
default:NONE
Available options:
FAST_BLUE,
FAST_GREEN,
NONE,
SIMPLE,
SLOW,
SLOWER,
SLOWEST
Example:

"FAST_BLUE"

sampler
enum<string>

Which sampler to use for the diffusion process. If this value is omitted we'll automatically select an appropriate sampler for you.

Available options:
DDIM,
DDPM,
K_DPMPP_2M,
K_DPMPP_2S_ANCESTRAL,
K_DPM_2,
K_DPM_2_ANCESTRAL,
K_EULER,
K_EULER_ANCESTRAL,
K_HEUN,
K_LMS
Example:

"K_DPM_2_ANCESTRAL"

samples
integer
default:1

Number of images to generate

Required range: 1 <= x <= 10
Example:

1

seed
integer
default:0

Random noise seed (omit this option or use 0 for a random seed)

Required range: 0 <= x <= 4294967295
Example:

0

steps
integer
default:30

Number of diffusion steps to run.

Required range: 10 <= x <= 50
Example:

50

style_preset
enum<string>

Pass in a style preset to guide the image model towards a particular style. This list of style presets is subject to change.

Available options:
3d-model,
analog-film,
anime,
cinematic,
comic-book,
digital-art,
enhance,
fantasy-art,
isometric,
line-art,
low-poly,
modeling-compound,
neon-punk,
origami,
photographic,
pixel-art,
tile-texture
extras
object

Extra parameters passed to the engine. These parameters are used for in-development or experimental features and may change without warning, so please use with caution.

Response

Request succeeded.

An array of results from the generation request, where each image is a base64 encoded PNG.

artifacts
object[]