--- title: Create a variant --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Images](https://developers.cloudflare.com/api/typescript/resources/images) [V1](https://developers.cloudflare.com/api/typescript/resources/images/subresources/v1) [Variants](https://developers.cloudflare.com/api/typescript/resources/images/subresources/v1/subresources/variants) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a variant client.images.v1.variants.create(VariantCreateParams {account\_id, id, options, neverRequireSignedURLs } params, RequestOptionsoptions?): [VariantCreateResponse]() {variant } POST/accounts/{account\_id}/images/v1/variants Create a CF Images variant that allows you to resize images for different use cases. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Images Write` ##### ParametersExpand Collapse
params: VariantCreateParams {account\_id, id, options, neverRequireSignedURLs } account\_id: string Path param: Account identifier tag. maxLength32 Link to this property id: string Body param maxLength99 Link to this property
options: Options Body param: Allows you to define image resizing sizes for different use cases.
fit: "scale-down"| "contain"| "cover"| 2 more The fit property describes how the width and height dimensions should be interpreted. One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property
Link to this property height: number Maximum height in image pixels. minimum1 Link to this property
metadata: "keep"| "copyright"| "none" What EXIF data should be preserved in the output image. One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property
Link to this property width: number Maximum width in image pixels. minimum1 Link to this property
Link to this property neverRequireSignedURLs?: boolean Body param: Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property
[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
VariantCreateResponse {variant }
variant?: Variant {id, options, neverRequireSignedURLs } id: string maxLength99 Link to this property
options: Options {fit, height, metadata, width } Allows you to define image resizing sizes for different use cases.
fit: "scale-down"| "contain"| "cover"| 2 more The fit property describes how the width and height dimensions should be interpreted. One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property
Link to this property height: number Maximum height in image pixels. minimum1 Link to this property
metadata: "keep"| "copyright"| "none" What EXIF data should be preserved in the output image. One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property
Link to this property width: number Maximum width in image pixels. minimum1 Link to this property
Link to this property neverRequireSignedURLs?: boolean Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property
Link to this property
[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant_create_response%20%3E%20(schema)>) ### Create a variant TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const variant = await client.images.v1.variants.create({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', id: 'hero', options: { fit: 'scale-down', height: 768, metadata: 'none', width: 1366, }, }); console.log(variant.variant); ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "variant": { "id": "hero", "options": { "fit": "scale-down", "height": 768, "metadata": "none", "width": 1366 }, "neverRequireSignedURLs": true } }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "variant": { "id": "hero", "options": { "fit": "scale-down", "height": 768, "metadata": "none", "width": 1366 }, "neverRequireSignedURLs": true } }, "success": true } ```