Configuration for image output format.

interface ImageResponseFormat {
    aspect_ratio?:
        | "1:1"
        | "2:3"
        | "3:2"
        | "3:4"
        | "4:3"
        | "4:5"
        | "5:4"
        | "9:16"
        | "16:9"
        | "21:9"
        | "1:8"
        | "8:1"
        | "1:4"
        | "4:1";
    delivery?: "inline"
    | "uri";
    image_size?: "1K" | "2K" | "4K" | "512";
    mime_type?: "image/jpeg";
    type: "image";
}

Properties

aspect_ratio?:
    | "1:1"
    | "2:3"
    | "3:2"
    | "3:4"
    | "4:3"
    | "4:5"
    | "5:4"
    | "9:16"
    | "16:9"
    | "21:9"
    | "1:8"
    | "8:1"
    | "1:4"
    | "4:1"

The aspect ratio for the image output.

delivery?: "inline" | "uri"

The delivery mode for the image output.

image_size?: "1K" | "2K" | "4K" | "512"

The size of the image output.

mime_type?: "image/jpeg"

The MIME type of the image output.

type: "image"