--- title: Upload an image --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Images](https://developers.cloudflare.com/api/python/resources/images) [V1](https://developers.cloudflare.com/api/python/resources/images/subresources/v1) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Upload an image images.v1.create(V1CreateParams\*\*kwargs) -> [Image]() POST/accounts/{account\_id}/images/v1 Upload an image to CF Images. Images up to 10 Megabytes can be uploaded using a single HTTP POST (multipart/form-data) request by sending an image file or passing a URL accessible to the API. ##### 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 account\_id: str Account identifier tag. maxLength32 [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) id: Optional\[str] An optional custom unique identifier for your image. [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>) creator: Optional\[str] Can set the creator field with an internal user ID. maxLength1024 [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20creator%20%3E%20(schema)>) file: Optional\[[FileTypes]()] An image binary data. Only needed when type is uploading a file. [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20file%20%3E%20(schema)>) metadata: Optional\[[object]()] User modifiable key-value store. Can use used for keeping references to another system of record for managing images. [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20metadata%20%3E%20(schema)>) require\_signed\_urls: Optional\[[bool]()] Indicates whether the image requires a signature token for the access. [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20requireSignedURLs%20%3E%20(schema)>) url: Optional\[str] A URL to fetch an image from origin. Only needed when type is uploading from a URL. [Link to this property](<#(resource)%20images.v1%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20url%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Image: … id: Optional\[str] Image unique identifier. maxLength32 Link to this property creator: Optional\[str] Can set the creator field with an internal user ID. maxLength1024 Link to this property filename: Optional\[str] Image file name. maxLength255 Link to this property meta: Optional\[object] User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes. Link to this property require\_signed\_urls: Optional\[bool] Indicates whether the image can be a accessed only using it’s UID. If set to true, a signed token needs to be generated with a signing key to view the image. Link to this property uploaded: Optional\[datetime] When the media item was uploaded. formatdate-time Link to this property variants: Optional\[List\[str]] Object specifying available variants for an image. Link to this property
[Link to this property](<#(resource)%20images.v1%20%3E%20(model)%20image%20%3E%20(schema)>) ### Upload an image Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) image = client.images.v1.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(image.id) ``` 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": { "id": "id", "creator": "107b9558-dd06-4bbd-5fef-9c2c16bb7900", "filename": "logo.png", "meta": { "key": "value" }, "requireSignedURLs": true, "uploaded": "2014-01-02T02:20:00.123Z", "variants": [ "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail", "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero", "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original" ] }, "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": { "id": "id", "creator": "107b9558-dd06-4bbd-5fef-9c2c16bb7900", "filename": "logo.png", "meta": { "key": "value" }, "requireSignedURLs": true, "uploaded": "2014-01-02T02:20:00.123Z", "variants": [ "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail", "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero", "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original" ] }, "success": true } ```