SUsudoapp
router

Generate Image

post/v1/images/generations

Request

  • Base URL
    https://docs.sudoapp.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

promptstring required

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.

modelstring required

The model to use for image generation.

ninteger nullable

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

response_format'url' | 'b64_json' nullable

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.

quality'standard' | 'hd' nullable

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.

size'256x256' | '512x512' | '1024x1024' | '1792x1024' | '1024x1792' nullable

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.

style'vivid' | 'natural' nullable

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.

backgroundstring nullable

OpenAI only: Specify the background removal for the generated image.

moderationstring nullable

OpenAI only: Content moderation settings for the image generation.

output_compressioninteger nullable

OpenAI only: Compression level for the output image, from 0 to 100.

output_formatstring nullable

OpenAI only: The output format for the generated image.

Response

Image generated successfully

backgroundstring nullable

Background settings used in generation (OpenAI only)

createdinteger nullable

The Unix timestamp (in seconds) of when the image was created.

output_formatstring nullable

The output format of the generated image (OpenAI only)

qualitystring nullable

The quality setting used for generation (OpenAI only)

sizestring nullable

The size of the generated image (OpenAI only)

Changes

No recorded changes to this operation across all 1 revision of this API.