ExOpenAI.Images.create_image
You're seeing just the function
create_image
, go back to ExOpenAI.Images module for more information.
Specs
create_image( String.t(), {:user, String.t()} | {:size, String.t()} | {:response_format, String.t()} | {:n, integer()} ) :: {:ok, ExOpenAI.Components.ImagesResponse.t()} | {:error, any()}
Creates an image given a prompt.
Endpoint: https://api.openai.com/v1/images/generations
Method: POST
Docs: https://platform.openai.com/docs/api-reference/images
Required Arguments:
prompt
: A text description of the desired image(s). The maximum length is 1000 characters.
Example: A cute baby sea otter
Optional Arguments:
n
: The number of images to generate. Must be between 1 and 10.
Example: 1
response_format
: The format in which the generated images are returned. Must be one ofurl
orb64_json
.
Example: "url"
size
: The size of the generated images. Must be one of256x256
,512x512
, or1024x1024
.
Example: "1024x1024"
user
: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Example: "user-1234"