OpenAIImagesEditsRequest

  • image
    required

    Input image or images to edit.

    • Type: string Format: binary

      Single source image file.

  • prompt
    Type: string
    required

    Text instruction describing the desired edit.

  • background
    Type: string enum

    Only supported by gpt-image-1.

    values
    • transparent
    • opaque
    • auto
  • input_fidelity
    Type: string enum

    Only supported by gpt-image-1.

    values
    • high
    • low
  • mask
    Type: string Format: binary

    Optional PNG mask file. Usually must match the image dimensions.

  • model
    Type: string enum

    Image editing model.

    values
    • gpt-image-1
    • dall-e-2
  • n
    Type: integer
    min:  
    1
    max:  
    10

    Number of edited images to generate.

  • output_compression
    Type: integer
    min:  
    0
    max:  
    100

    Compression level for gpt-image-1 jpeg/webp output.

  • output_format
    Type: string enum

    Only supported by gpt-image-1.

    values
    • png
    • jpeg
    • webp
  • partial_images
    Type: integer
    min:  
    0
    max:  
    3

    Number of partial images for streaming previews.

  • quality
    Type: string enum

    Supported values vary by model.

    values
    • auto
    • high
    • medium
    • low
    • standard
  • response_format
    Type: string enum

    Only applies to dall-e-2.

    values
    • url
    • b64_json
  • size
    Type: string enum

    Allowed values depend on the selected model.

    values
    • 1024x1024
    • 1536x1024
    • 1024x1536
    • auto
    • 256x256
    • 512x512
  • stream
    Type: boolean

    Streams edited image output when supported.

  • user
    Type: string

    Unique identifier for the end user.