Skip to main content
POST
Start a large upload

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Headers

If-Match
string

ID of the version you edited, optionally quoted (a W/ prefix is ignored). Only valid with file_id. A non-numeric value, or If-Match without file_id, returns 422.

Body

application/json
name
string
required

File name, including the extension

Maximum string length: 200
Example:

"STYLE123_BLK_01.jpg"

size
integer
required

File size in bytes (max 500 MB). Must match the uploaded bytes.

Required range: x >= 1
mime_type
string | null
Maximum string length: 150
Example:

"image/jpeg"

folder_id
integer

Folder to create the file in. Required unless file_id is sent.

file_id
integer

Existing file to add a new version to. Required unless folder_id is sent.

Response

Upload started

data
object