API Reference

Images

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Variants

List variants

client.Images.V1.Variants.List(ctx, query) (*Variant, error)

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

Variant details

client.Images.V1.Variants.Get(ctx, variantID, query) (*V1VariantGetResponse, error)

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

Create a variant

client.Images.V1.Variants.New(ctx, params) (*V1VariantNewResponse, error)

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

Update a variant

client.Images.V1.Variants.Edit(ctx, variantID, params) (*V1VariantEditResponse, error)

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

Delete a variant

client.Images.V1.Variants.Delete(ctx, variantID, body) (*unknown, error)

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

ModelsExpand Collapse

type Variant struct{…}

Variants VariantVariantsOptional

Hero VariantVariantsHeroOptional

ID string

maxLength99

Options VariantVariantsHeroOptions

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

Fit VariantVariantsHeroOptionsFit

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

One of the following:

const VariantVariantsHeroOptionsFitScaleDown VariantVariantsHeroOptionsFit = "scale-down"

const VariantVariantsHeroOptionsFitContain VariantVariantsHeroOptionsFit = "contain"

const VariantVariantsHeroOptionsFitCover VariantVariantsHeroOptionsFit = "cover"

const VariantVariantsHeroOptionsFitCrop VariantVariantsHeroOptionsFit = "crop"

const VariantVariantsHeroOptionsFitPad VariantVariantsHeroOptionsFit = "pad"

Height float64

Maximum height in image pixels.

minimum1

Metadata VariantVariantsHeroOptionsMetadata

What EXIF data should be preserved in the output image.

One of the following:

const VariantVariantsHeroOptionsMetadataKeep VariantVariantsHeroOptionsMetadata = "keep"

const VariantVariantsHeroOptionsMetadataCopyright VariantVariantsHeroOptionsMetadata = "copyright"

const VariantVariantsHeroOptionsMetadataNone VariantVariantsHeroOptionsMetadata = "none"

Width float64

Maximum width in image pixels.

minimum1

NeverRequireSignedURLs boolOptional

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