Stable Diffusion 3 Text To Image API Introduction
Generate an image using a Stable Diffusion 3 model.Generating with a prompt.
Credits
The service uses 8 credits per successful result. You will not be charged for failed results.
Example Request and Response
API Documentation
API Endpoint | Method |
---|---|
/api/generate/sdv3/textToImage | POST |
Request Header
Parameter | Description |
---|---|
Authentication | Use 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:
Parameter | Type | Required | Description |
---|---|---|---|
prompt | string | Yes | The text description or prompt used to generate the image. |
width | int | Yes | The desired pixel width for the generated image should be between 320 and 1536 pixels, in an increment divisible by 64. |
height | int | Yes | The desired pixel height for the generated image should be between 320 and 1536 pixels, in an increment divisible by 64. |
model | string | No | Enum: sd3-large sd3-large-turbo sd3-medium Default: sd3-large The model to use for generation. |
aspect_ratio | string | No | Enum: 16:9 1:1 21:9 2:3 3:2 4:5 5:4 9:16 9:21 Default: 1:1 Controls the aspect ratio of the generated image. |
seed | init | No | Random noise seed (omit this option or use 0 for a random seed). |
negative_prompt | string | No | Keywords of what you do not wish to see in the output image. This is an advanced feature.This parameter does not work with sd3-large-turbo. |
Response Body
The response should include a JSON object in the body with the following parameters:
Parameter | Type | Description |
---|---|---|
code | int | Status Code, 0 for success callback, -1 for failure callback |
message | string | Callback message, 'success' for success, failure reason for failure |
data | object | Image Details |
Image Details
Parameter | Type | Description |
---|---|---|
image | string | Return the base64 encoded image of the generated picture. |
seed | int | The seed used as random noise for this generation. |
Example Request
import requests
import json
url = "https://www.aithriving.com/api/generate/sd3/textToImage"
headers = {
'Accept': 'application/json',
'Authorization': 'your-auth-token',
}
data = {
'prompt': 'A lighthouse on a cliff',
'height': 1024,
'width': 1024,
}
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
}
}