Expand description
The Uploads API: upload large files in multiple parts via /uploads.
![warn] This module is untested! If you encounter any issues, please report them on the repository.
The Uploads API lets you upload large files (up to 8 GB per part
upload) in multiple parts, which is more resilient to network
interruptions than a single multipart request through
files::create. The workflow is:
create— start an upload, declaring the total byte size.parts— upload each chunk (up to 64 MB per part, except the last).complete— finalize the upload with the ordered part IDs, yielding aFileObject.
A started-but-incomplete upload can be discarded via cancel.
Modules§
- cancel
- Cancel an upload via
POST /uploads/{upload_id}/cancel. - complete
- Complete an upload via
POST /uploads/{upload_id}/complete. - parts
- Add an upload part via
POST /uploads/{upload_id}/parts.
Structs§
- Create
Upload Request - Starts an upload session via
POST /uploads. - Upload
- An upload session.
- Upload
Part - A single uploaded part of a multi-part upload.
Enums§
- Upload
Status - The status of an upload.