Variants

List variants

GET/accounts/{account_id}/images/v1/variants

Variant details

GET/accounts/{account_id}/images/v1/variants/{variant_id}

Create a variant

POST/accounts/{account_id}/images/v1/variants

Update a variant

PATCH/accounts/{account_id}/images/v1/variants/{variant_id}

Delete a variant

DELETE/accounts/{account_id}/images/v1/variants/{variant_id}

ModelsExpand Collapse

Variant object { variants }

variants: optional object { hero }

hero: optional object { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: object { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" or "contain" or "cover" or 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" or "copyright" or "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs: optional boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantGetResponse object { variant }

variant: optional object { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: object { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" or "contain" or "cover" or 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" or "copyright" or "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs: optional boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantCreateResponse object { variant }

variant: optional object { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: object { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" or "contain" or "cover" or 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" or "copyright" or "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs: optional boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantEditResponse object { variant }

variant: optional object { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: object { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" or "contain" or "cover" or 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" or "copyright" or "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs: optional boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantDeleteResponse = unknown or string

One of the following:

unknown

string