Data Types


Request body for BeginMultipartUpload.


"mime": String,
"protocol": String,
"size": Integer,
"tags": String[]


"metadata": {
"myCustomField1": true,
"myCustomField2": {
"hello": "world"
"anotherCustomField": 42
"mime": "image/jpeg",
"originalFileName": "example.jpg",
"path": {
"fileName": "image.jpg",
"fileNameVariablesEnabled": true,
"folderPath": "/uploads",
"folderPathVariablesEnabled": true
"protocol": "1.0",
"size": 43182,
"tags": [



An arbitrary JSON object to store against the file as metadata.

You can retrieve this later via a GetFileDetails request.

Type: FileMetadata

Required: No


The file's MIME type.

Type: String

Min Length: 3

Max Length: 255

Example: "image/jpeg"

Required: No


The file's original name on the user's device.

Type: String

Min Length: 1

Max Length: 255

Example: "example.jpg"

Required: No


The path to upload the file to.

Type: FilePathDefinition

Required: No


Multipart upload protocol version to use.

The latest Upload SDKs use the latest supported version.

Recommended: "1.1"

Default: "1.0"

Type: String

Allowed Values: "1.0", "1.1"

Required: No


The size of the file in bytes.

Type: Integer

Minimum: 0

Example: 43182

Required: Yes


The file tags to store against the file.

When you associate file tags with a file, Upload checks which rules match the tags (if any) and applies those rules to the upload request:

Rules can include max file size checks, traffic limit checks, rate limit checks, and so forth. These are configured in the Upload Dashboard.

Type: String[]

Example: ["images/profile"]

Required: No

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: