Skip to main content
POST
Start a file upload

Authorizations

Authorization
string
header
required

Paste your VTurb API token (vt_...). Sent as Authorization: Bearer <token>.

Body

application/json
name
string
required

Display name for the file.

Maximum string length: 255
Example:

"My thumbnail"

filename
string
required

Original filename of the upload.

Maximum string length: 255
Example:

"mythumbnail.jpg"

content_type
enum<string>
required

MIME type of the file.

Available options:
image/png,
image/jpeg,
image/gif,
image/webp,
text/vtt
Example:

"image/jpeg"

size
integer<int64>
required

Size of the file in bytes (max 20MB).

Required range: 1 <= x <= 20971520
Example:

184856

checksum
string

Optional SHA-256 checksum of the file (64 hex characters). When given, the presign locks it so S3 rejects any upload whose bytes don't match.

Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

folder_id
string

Optional folder to place the file in.

Example:

"6890000000000000000000a1"

Response

checksum is optional; omit it to skip the upload integrity check.

id
string
required
status
enum<string>
required
Available options:
awaiting_upload,
active
upload
object
required
complete_url
string
required