CreateImageRequest.md

OpenapiClient::CreateImageRequest

Properties

Name	Type	Description	Notes
prompt	String	A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.
model	CreateImageRequestModel		[optional]
n	Integer	The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.	[optional][default to 1]
quality	String	The quality of the image that will be generated. `hd` creates images with finer details and greater consistency across the image. This param is only supported for `dall-e-3`.	[optional][default to 'standard']
response_format	String	The format in which the generated images are returned. Must be one of `url` or `b64_json`.	[optional][default to 'url']
size	String	The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3` models.	[optional][default to '1024x1024']
style	String	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. This param is only supported for `dall-e-3`.	[optional][default to 'vivid']
user	String	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.	[optional]

Example

require 'openapi_client'

instance = OpenapiClient::CreateImageRequest.new(
  prompt: A cute baby sea otter,
  model: null,
  n: 1,
  quality: standard,
  response_format: url,
  size: 1024x1024,
  style: vivid,
  user: user-1234
)