Images

Generate Images

This API endpoint allows you to generate images based on the provided model, prompt, and other parameters.Please use the streaming output to view the process in real time.

Request Body

model (string, required): The model to be used for image generation.

prompt (string, required): The prompt for image generation.

n (integer, required): The number of images to generate.

size (string, required): The size of the generated image.

Request

Header Params

Authorization

string

required

Example:

Bearer {{api-key}}

Body Params application/json

model

string

required

dall-e-3,gpt-image-1,flux-kontext-max, flux-kontext-pro

Default:

dall-e-3

Example:

gpt-image-1

prompt

string

required

Text description of the desired image. The maximum length is 1000 characters.

integer

optional

Number of images to generate. Must be between 1 and 10.

size

string

optional

The size of the generated image. Must be one of 256x256, 512x512, or 1024x1024.

Example

{
    "model": "dall-e-3",
    "prompt": "A cute baby sea otter",
    "n": 1,
    "stream": true,
    "size": "1024x1024"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Successful Response

application/json

Body

created

integer

required

Unix timestamp of when the image generation task was completed

data

array [object {2}]

required

A list containing information about the generated images.

revised_prompt

string

optional

The model may have optimized or rewritten the original prompt words provided by the user.

url

string

optional

A URL pointing to the generated image file. this URL is usually time-sensitive and the user needs to download the image in time.

Example

{
  "created": 1737352021,
  "data": [
    {
      "revised_prompt": "A small and adorable sea otter pup. It's floating on its back in a tranquil, azure sea, sunlight streaming down on its thick, wet fur. The otter pup is contentedly munching on a bright pink shrimp, holding it between its little paws while remaining completely buoyant, displaying its nimble acrobatic skills that come naturally to its species. The pup's eyes are bright with curiosity and innocence, exploring the vast sea around it while enjoying its meal. The blue-green water around it is dancing with the sunlight, creating a serene environment for the otter pup's mealtime.",
      "url": "https://oaidalleapiprodscus.blob.core.windows.net/private/org-nRhUPivdBTlVXzF8KaZBo9vY/user-IuAvdMlDArmYuupuySzt6BqQ/img-AtYEsUJaP70OFEPyqFbSuxSE.png?st=2025-01-20T04%3A47%3A01Z&se=2025-01-20T06%3A47%3A01Z&sp=r&sv=2024-08-04&sr=b&rscd=inline&rsct=image/png&skoid=d505667d-d6c1-4a0a-bac7-5c84a87759f8&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-01-20T00%3A45%3A01Z&ske=2025-01-21T00%3A45%3A01Z&sks=b&skv=2024-08-04&sig=Op4s4mFKwrX6i/O43KZ/23EAWY2LnQTfY2ooxaFZNM0%3D"
    }
  ]
}

Generate Images#

Request Body#

Request

Request samples

Responses

Generate Images

Request Body