Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 14.2 KB

createimagerequest.md

File metadata and controls

31 lines (26 loc) · 14.2 KB
Raw

CreateImageRequest

Example Usage

import { CreateImageRequest } from "argot-open-ai/models/components";

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

Fields

Field Type Required Description Example
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. A cute baby sea otter
model components.CreateImageRequestModel ➖ The model to use for image generation. dall-e-3
n number ➖ The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported. 1
quality components.Quality ➖ 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. standard
responseFormat components.CreateImageRequestResponseFormat ➖ The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. url
size components.Size ➖ 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. 1024x1024
style components.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. This param is only supported for dall-e-3. vivid
user string ➖ A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
 user-1234