Start a file upload

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Display name for the file.

Lengthlength <= 255

filename*string

Original filename of the upload.

Lengthlength <= 255

content_type*string

MIME type of the file.

Value in

"image/png"
"image/jpeg"
"image/gif"
"image/webp"
"text/vtt"

size*integer

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

Formatint64

Range1 <= value <= 20971520

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.

folder_id?string

Optional folder to place the file in.

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/v1/files" \  -H "Content-Type: application/json" \  -d '{    "name": "My thumbnail",    "filename": "mythumbnail.jpg",    "content_type": "image/jpeg",    "size": 184856,    "checksum": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "folder_id": "6890000000000000000000a1"  }'

{  "id": "0190a0b0-0000-7000-8000-000000000001",  "status": "awaiting_upload",  "upload": {    "url": "https://s3.amazonaws.com/vturb-uploads/org_123/x/original.jpg?x-amz-checksum-sha256=qqq%3D&X-Amz-Signature=abc",    "expires_at": "2026-08-13T12:15:00Z"  },  "complete_url": "/v1/files/0190a0b0-0000-7000-8000-000000000001/upload/completion"}

Start a file upload

Authorization

Request Body

Response Body

201application/json

401application/problem+json

403application/problem+json

422application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`