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

Creates an image given a prompt.

Operation ID

createImage

$client->createImage( ... );

Parameters

Request Body

Content Type: application/json

Models

The model to use for image generation.

• dall-e-2

• dall-e-3

Example:

{
   "model" : "dall-e-3",
   "n" : 1,
   "prompt" : "A cute baby sea otter",
   "quality" : "standard",
   "response_format" : "url",
   "size" : "1024x1024",
   "style" : "vivid",
   "user" : "user-1234"
}


         

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "data" : [
        "{\n  \"url\": \"...\",\n  \"revised_prompt\": \"...\"\n}\n"
     ]
  }

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.