Text-to-image

Generate an image from a text prompt.

Using SDXL 1.0

Use stable-diffusion-xl-1024-v1-0 as the engine_id of your request and pass in height & width as one of the following combinations:

1024x1024

1152x896

896x1152

1216x832

1344x768

768x1344

1536x640

640x1536.

Using SD 1.6

Pass in stable-diffusion-v1-6 as the engine_id of your request and ensure the height & width you pass in adhere to the following restrictions:

No dimension can be less than 320 pixels

No dimension can be greater than 1536 pixels

Using SD Beta

Pass in stable-diffusion-xl-beta-v2-2-2 as the engine_id of your request and ensure the height & width you pass in adhere to the following restrictions:

dimensions must be between 128x128 and 512x896 (or 896x512)

only one dimension can be greater than 512, but not both

NOTE: Only Version 1 engines will work with this endpoint.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "cfg_scale": 7,
    "height": 512,
    "width": 512,
    "sampler": "K_DPM_2_ANCESTRAL",
    "samples": 1,
    "steps": 30,
    "text_prompts": [
        {
            "text": "A lighthouse on a cliff",
            "weight": 1
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Generation successful.

application/json

Body

Example

{
    "artifacts": [
        [
            {
                "base64": "...very long string...",
                "finishReason": "SUCCESS",
                "seed": 1050625087
            },
            {
                "base64": "...very long string...",
                "finishReason": "CONTENT_FILTERED",
                "seed": 1229191277
            }
        ]
    ]
}

🟠400bad_request: one or more parameters were invalid.

🟠401unauthorized: API key missing or invalid

🟠403permission_denied: You lack the necessary permissions to perform this action

🟠404not_found: The requested resource/engine was not found

🔴500server_error: Some unexpected server error occurred

Using SDXL 1.0#