Skip to main content
POST
/
vault
/
{id}
/
multipart
/
init
{
  "objectId": "<string>",
  "uploadId": "<string>",
  "s3Key": "<string>",
  "partSizeBytes": 123,
  "partCount": 123,
  "next_step": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_case_

Path Parameters

​
id
string
required

Vault ID to upload the file to

Body

application/json
​
filename
string
required

Name of the file to upload

​
contentType
string
required

MIME type of the file

​
sizeBytes
integer
required

File size in bytes (required, default max 16GB). Configure via VAULT_MULTIPART_MAX_FILE_SIZE_BYTES.

Required range: x >= 1
​
partSizeBytes
integer

Multipart part size in bytes (min 5MB, max 5GB). Defaults to 64MB.

Required range: 5242880 <= x <= 5368709120
​
metadata
object

Additional metadata to associate with the file

​
auto_index
boolean
default:true

Whether to automatically process and index the file for search

​
is_ai_generated
boolean
default:false

Marks the file as AI-generated work product (e.g. uploaded by an agent) rather than a user-provided source document. Persisted on the object and returned by object listings so clients can distinguish provenance.

​
path
string

Optional folder path for hierarchy preservation

Response

200 - application/json

Multipart upload initiated

​
objectId
string
​
uploadId
string
​
s3Key
string
​
partSizeBytes
integer
​
partCount
integer
​
next_step
string