Images
Given a prompt and/or an input image, the model will generate a new image.
resource openai_image
required
The image(s) to edit. Must be a supported image file or an array of images.
For the GPT image models (gpt-image-1, gpt-image-1-mini, and gpt-image-1.5), each image should be a png, webp, or jpg
file less than 50MB. You can provide up to 16 images.
chatgpt-image-latest follows the same input constraints as GPT image models.
For dall-e-2, you can only provide one image, and it should be a square
png file less than 4MB.
optional
Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
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. This parameter is only supported for dall-e-2 (default is url for dall-e-2), as GPT image models always return base64-encoded images.
Edit the image in streaming mode. Defaults to false. See the
Image generation guide for more information.
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Allows to set transparency for the background of the generated image(s).
This parameter is only supported for the GPT image models. Must be one of
transparent, opaque or auto (default value). When auto is used, the
model will automatically determine the best background for the image.
If transparent, the output format needs to support transparency, so it
should be set to either png (default value) or webp.
The compression level (0-100%) for the generated images. This parameter
is only supported for the GPT image models with the webp or jpeg output
formats, and defaults to 100.
The format in which the generated images are returned. This parameter is
only supported for the GPT image models. Must be one of png, jpeg, or webp.
The default value is png.
The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.
Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.
openai_image
resource "openai_image" "example_image" {
image = "Example data"
prompt = "A cute baby sea otter wearing a beret"
background = "transparent"
input_fidelity = "high"
mask = "Example data"
model = "string"
n = 1
output_compression = 100
output_format = "png"
partial_images = 1
quality = "high"
response_format = "url"
size = "1024x1024"
stream = false
user = "user-1234"
}