Skip to main content

An upload session for chunk uploading a file.

​
id
string

The unique identifier for this session.

Example:

"F971964745A5CD0C001BBE4E58196BFD"

​
type
enum<string>

The value will always be upload_session.

Available options:
upload_session
Example:

"upload_session"

​
session_expires_at
string<date-time>

The date and time when this session expires.

Example:

"2012-12-12T10:53:43-08:00"

​
part_size
integer<int64>

The size in bytes that must be used for all parts of of the upload.

Only the last part is allowed to be of a smaller size.

Example:

1024

​
total_parts
integer<int32>

The total number of parts expected in this upload session, as determined by the file size and part size.

Example:

1000

​
num_parts_processed
integer<int32>

The number of parts that have been uploaded and processed by the server. This starts at 0.

When committing a file files, inspecting this property can provide insight if all parts have been uploaded correctly.

Example:

455

​
session_endpoints
Session endpoints · object

A list of endpoints for this session.