Imagine Image
Creates a new image using AI
Description
The imagine endpoint allows you to create a new image using AI. At the moment,
the only supported model is the ByteDance SDXL-Lightning model,
which generates good quality images from text descriptions.
The images generated by the endpoint has a resolution of 1024x1024 pixels and are saved in PNG format.
Cat image generated by the endpoint
Request Body
The request body should contain a JSON object with the following fields:
The name of the image to identify it on the dashboard.
The text prompt to generate the image from.
The things to avoid in the generated image.
The seed to use for the random number generator.
Response
The API will return the created Image object in the response body.
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
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.
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 URL.
The width of the image in pixels.
The height of the image in pixels.
The format of the image. The format can be one of the following: jpeg, png, webp.
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.
The date and time when the image was created. The date and time are in ISO 8601 format.