Skip to main content

initiateDataRoomDocumentMultiPartUpload

Initiates a multipart upload for a large document. This mutation starts the upload session and calculates how the file will be split into multiple parts (chunks), preparing it for chunked uploading to storage.

To upload file chunks, the client must then call the generatePresignedUrlsForDataRoomDocumentMultiPartUpload mutation with the upload.id and requested part numbers. These secure pre-signed URLs allow the client to upload each part directly to storage.

After all parts are uploaded, the upload must be finalized using completeDataRoomDocumentMultiPartUpload.

To monitor the overall status, clients can poll the dataRoomDocumentUpload(id: ID!) query until the upload reaches:

COMPLETED: The document is processed and available. FAILED: The upload or post-processing failed.

initiateDataRoomDocumentMultiPartUpload(
  input: InitiateDataRoomDocumentMultiPartUploadInput!
): InitiateDataRoomDocumentMultiPartUploadPayload

Arguments​

initiateDataRoomDocumentMultiPartUpload.input ● InitiateDataRoomDocumentMultiPartUploadInput! non-null input​

Input including the Data Room ID, optional folder ID, file name, total size, and optional chunk size.

Type​

InitiateDataRoomDocumentMultiPartUploadPayload object​

Returned when initiating a multipart upload for a document in the Data Room. This payload provides the necessary information to begin uploading file parts, including the upload session metadata and the total number of expected parts.

This is the first step in the multipart upload flow. It includes an upload object for tracking the overall upload status and a totalParts value used to divide the file for chunked uploads.

To upload the file parts, clients must call the generatePresignedUrlsForDataRoomDocumentMultiPartUpload mutation, passing the upload.id and desired part numbers. This returns secure URLs that can be used to upload each chunk directly to storage.