NAME

OpenAPI::Client::OpenAI::Path::images-generations - Documentation for the /images/generations path.

DESCRIPTION

This document describes the API endpoint at /images/generations.

PATHS

POST /images/generations

Create image

Creates an image given a prompt. Learn more.

Operation ID

createImage

$client->createImage( ... );

Parameters

Request Body

Content Type: application/json

Models

The model to use for image generation. One of dall-e-2, dall-e-3, or gpt-image-1. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

• dall-e-2

• dall-e-3

• gpt-image-1

Example:

{
   "background" : "transparent",
   "moderation" : "low",
   "n" : 1,
   "output_compression" : 100,
   "output_format" : "png",
   "partial_images" : 1,
   "prompt" : "A cute baby sea otter",
   "quality" : "medium",
   "response_format" : "url",
   "size" : "1024x1024",
   "stream" : false,
   "style" : "vivid",
   "user" : "user-1234"
}


         

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
    "created": 1713833628,
    "data": [
      {
        "b64_json": "..."
      }
    ],
    "background": "transparent",
    "output_format": "png",
    "size": "1024x1024",
    "quality": "high",
    "usage": {
      "total_tokens": 100,
      "input_tokens": 50,
      "output_tokens": 50,
      "input_tokens_details": {
        "text_tokens": 10,
        "image_tokens": 40
      }
    }
  }

• text/event-stream

  Example (See the OpenAI spec for more detail):

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.