POST
/
v1
/
images
/
imagine
Imagine Image
curl --request POST \
  --url https://api.img-processing.com/v1/images/imagine \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "example-image",
  "prompt": "A beautiful sunset over the ocean.",
  "negative_prompt": "No people in the image.",
  "seed": 42
}'
{
  "id": "image_etm0g3x5iap4cld1qcfsjvo2",
  "name": "Processed Image",
  "url": "https://storage.img-processing.com/images/image_etm0g3x5iap4cld1qcfsjvo2",
  "width": 460,
  "height": 460,
  "format": "jpeg",
  "size": 282000,
  "created_at": "2021-09-01T12:00:00.000Z"
}

Description

The imagine endpoint allows you to create a new image using AI. At the moment, there is support for the models: ByteDance SDXL-Lightning and Flux, which generates good quality images from text descriptions.

The images generated by the endpoint has a resolution of 1024x1024 pixels and are saved in JPEG format.

Cat Image

Cat image generated by the endpoint


Authorizations

x-api-key
string
header
required

API Key for authentication

Body

application/json
name
string
required

The name of the image to identify it on the dashboard.

Required string length: 1 - 30
prompt
string
required

The prompt for the image. It should describe what you want to see in the generated image.

Required string length: 1 - 1000
negative_prompt
string

The negative prompt for the image. It should describe what you don't want to see in the generated image.

Required string length: 1 - 1000
seed
integer

The seed for the image. It is used to generate the image. If not provided, a random seed will be used.

Required range: x >= 0
model
enum<string>

The model to use for the image. If not provided, the default model will be used.

Available options:
sdxl,
flux

Response

201
application/json

The API will return the created Image object in the response body.

The Image object represents an image processed using the IMG Processing API. The object contains information about the image, such as its URL, size, and format. The Image object is returned in the response body of all image processing requests.

id
string
required

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

name
string
required

The name of the image. This name is provided when uploading the image and is the way the image is identified in your account. It is not unique, in fact, each transformation you make to an image will create a new image with the same name.

width
number
required

The width of the image in pixels.

height
number
required

The height of the image in pixels.

format
enum<string>
required

The format of the image. The format can be one of the following: jpeg, png, webp

Available options:
png,
jpeg,
webp
size
number
required

The estimated size of the image in bytes. The size is an estimate and may not be exact since images can be compressed or optimized depending on the format and quality settings used during processing.

created_at
string
required

The date and time when the image was created. The date and time are in ISO 8601 format.

url
string | null

The public URL of the image. By default, this URL is not available and will be null. You can make the image public by using the publish endpoint. Once the image is public, the URL will be updated with the public UR.