Skip to main content
POST

Overview

Starts a multipart upload for large files. The response gives you session_id, part_size (the chunk size in bytes), and parts (presigned URLs, in order). Upload each chunk with Upload parts, then finalize with Multipart complete.

Authentication

Authorization: Bearer YOUR_API_KEY

Workflow

This is step 1 of 3.
  1. Multipart start (this endpoint) — get session_id, part_size, and parts.
  2. Upload partsPUT each chunk to the matching presigned URL.
  3. Multipart complete — finalize the file in your workspace.

Request body

Response

Returns session_id, part_size, and parts. Part index i must be uploaded to parts[i].

Authorizations

x-api-key
string
header
required

API key for public endpoints. Can also be provided via Authorization: Bearer

Body

application/json
file_name
string
required
Minimum string length: 1
size
integer
required
Required range: 1 <= x <= 9007199254740991
format
string
required
Minimum string length: 1
folder
string
tags
metadata
object
custom_id
string
random_prefix
boolean
ttl_seconds
integer
Required range: 1 <= x <= 9007199254740991

Response

Session created

Session created

session_id
string
required
uuid
string
required
part_size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
min_part_size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
parts
string[]
required

Pre-signed S3 upload URLs, one per part

expire_at
integer
required

Unix timestamp when the session expires

Required range: -9007199254740991 <= x <= 9007199254740991
public_key
string
required
workspace_id
string
required
policy
object
required