Create Image

Create an image from a prompt.

Header Parameters

OpenAI-Organization?Openai-Organization

Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.

OpenAI-Project?Openai-Project

Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization

Request Body

promptPrompt

A text description of the desired image(s).

background?Background

Allows to set transparency for the background of the generated image(s).This parameter is supported on a subset of models.Must be one of transparent, opaque or auto (default value). When auto is provided, opaque will be used.If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

Default"auto"

Value in"auto" | "transparent" | "opaque"

model?Model

The model to use for image generation.

Default""

moderation?Moderation

Control the content-moderation level for images generated. Must be either low for less restrictive filtering or auto (default value).

Default"auto"

Value in"low" | "auto"

n?Images number

The number of images to generate. Must be between 1 and 10.

Default1

Range1 <= value <= 10

output_compression?Output Compression

The compression level (0-100%) for the generated images. This parameter is only supported with the webp or jpeg output formats, and defaults to 100.

Default100

Range0 <= value <= 100

output_format?Output Format

The format in which the generated images are returned. Must be one of png, jpeg, or webp.

Default"png"

Value in"png" | "webp" | "jpeg"

quality?Quality

The quality of the image that will be generated. auto (default value) will automatically select the best quality for the given model.

Default"auto"

response_format?Response Format

The format in which generated images are returned. Must be one of url or b64_json. Currently url is not supported.

Default"b64_json"

Value in"url" | "b64_json"

size?Size

The size of the generated images. Default (auto) size is 512x512.

Default"auto"

style?Style

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

Default"vivid"

user?User

A unique identifier representing your end-user, which can help to monitor and detect abuse.

Default""

Response Body

curl -X POST "https://loading/v1/images/generations" \
  -H "OpenAI-Organization: string" \
  -H "OpenAI-Project: string" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "random",
    "prompt": "Black Swan",
    "size": "1024x1024"
  }'

curl -X POST "https://loading/v1/images/generations" \  -H "OpenAI-Organization: string" \  -H "OpenAI-Project: string" \  -H "Content-Type: application/json" \  -d '{    "model": "random",    "prompt": "Black Swan",    "size": "1024x1024"  }'

{
  "created": 1713833628,
  "data": [
    {
      "b64_json": "..."
    }
  ],
  "usage": {
    "input_tokens": 50,
    "input_tokens_details": {
      "image_tokens": 40,
      "text_tokens": 10
    },
    "output_tokens": 50,
    "total_tokens": 100
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Header Parameters

Request Body

Response Body

200

422