Given a prompt, create an image.

For more information, refer to the OpenAI Image Generation API docs.

yaml
type: "io.kestra.plugin.openai.createimage"

yaml
id: openai
namespace: company.team

tasks:
  - id: create_image
    type: io.kestra.plugin.openai.CreateImage
    prompt: A funny cat in a black suit
    apiKey: <your-api-key>
    download: true
    n: 5

The OpenAI API key.

Message to send to the API as prompt.

Default LARGE

Possible Values

SMALLMEDIUMLARGE

The size of the generated images.

Default 10

The maximum number of seconds to wait for a response.

Default false

Whether to download the generated image

If enable, the generated image will be downloaded inside Kestra's internal storage. Else, the URL of the generated image will be available as task output.

The number of images to generate. Must be between 1 and 10.

A unique identifier representing your end-user.

SubType string

Generated images.