Basic Text To Image API Introduction

Generate images using SD1.6, generate an image from a text prompt.

Credits

The service uses 0.4-2 credits per successful result. You will not be charged for failed results.

Example Request and Response

API Documentation

API EndpointMethod
/api/generate/basic/textToImagePOST

Request Header

ParameterDescription
AuthenticationUse your API key to authentication requests to this App.

Request Body

The request should include a JSON object in the body with the following parameters:

ParameterTypeRequiredDescription
promptstringYes

The text description or prompt used to generate the image.

widthintYes

The desired pixel width for the generated image should be between 320 and 1536 pixels, in an increment divisible by 64.

heightintYes

The desired pixel height for the generated image should be between 320 and 1536 pixels, in an increment divisible by 64.

cfg_scaleintNo

Range: [0,35]

Default: 7

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

clip_guidance_presetstringNo

Enum: FAST_BLUE FAST_GREEN NONE SIMPLE SLOW SLOWER SLOWEST

samplerstringNo

Enum: 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

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

seedinitNo

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

stepsinitNo

Range: [10, 50]

Default: 30

Number of diffusion steps to run.

style_presetstringNo

Enum: 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

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

Response Body

The response should include a JSON object in the body with the following parameters:

ParameterTypeDescription
codeintStatus Code, 0 for success callback, -1 for failure callback
messagestringCallback message, 'success' for success, failure reason for failure
dataobjectImage Details

Image Details

ParameterTypeDescription
imagestringReturn the base64 encoded image of the generated picture.
seedintThe seed used as random noise for this generation.

Example Request

import requests
import json

url = "https://www.aithriving.com/api/generate/basic/textToImage"
headers = {
    'Accept': 'application/json',
    'Authorization': 'your-auth-token',
}

data = {
    'prompt': 'A lighthouse on a cliff',
    'cfg_scale': 7,
    'height': 1024,
    'width': 1024,
    'steps': 20,
}

response = requests.post(url, headers=headers, data=json.dumps(data))

if response.status_code == 200:
    response_data = response.json()
    if response_data.get('code') == 0:
        with open("./result.png", "wb") as file:
            file.write(response_data['data']['image'].encode('utf-8'))
else:
    print(f"Request failed with status {response.status_code}")

Example Response

{
  "code": 0,
  "message": "success",
  "data": {
    "image": "base64 encoded image data",
    "seed": 1050625087
  }
}