Skip to main content
POST
/
v1
/
images
/
text-to-image
Error
A valid request URL is required to generate request examples
{
  "images": [
    {
      "url": "<string>",
      "content_type": "image/jpeg"
    }
  ],
  "prompt": "<string>",
  "timings": {
    "total": 123
  },
  "seed": 123,
  "has_nsfw_concepts": [
    true
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
prompt
string
required

The prompt to generate the image from

​
num_inference_steps
integer | null

Number of inference steps

​
controlnets
ControlNet · object[]

List of ControlNet configurations

​
controlnet_unions
ControlNetUnion · object[]

List of ControlNet union configurations

​
ip_adapters
IpAdapter · object[]

List of IP-Adapter configurations

​
guidance_scale
number | null

Guidance scale for the generation

​
real_cfg_scale
number | null

Real CFG scale

​
num_images
integer | null

Number of images to generate

​
enable_safety_checker
boolean | null

Whether to enable safety checker

​
reference_strength
number | null

Reference strength

​
reference_end
number | null

Reference end

​
image_url
string | null

Optional source image URL for image-to-image generation

​
strength
number | null

Strength of the conditioning

​
aspect_ratio
enum<string>
default:16:9

Desired aspect ratio for the generated image

Available options:
1:1,
16:9,
9:16
​
seed
integer

Seed for the generation

Response

Successful Response

Response body for image generation requests

​
images
GeneratedImage · object[]
required

The generated image files info

​
prompt
string
required

The prompt used for generating the image

​
timings
Timings · object

Timing information

​
seed
integer | null

Seed used for generation

​
has_nsfw_concepts
boolean[] | null

Whether images contain NSFW concepts