HAharvey
Vault

Upload Files to Project

The Upload Files API endpoint enables organizations to both upload new files and update existing ones within Vault projects. A maximum of 50 files can be uploaded per API request.

post/api/v1/vault/upload_files/{project_id}

Request

Path parameters

project_idstring required

The project ID.

Request body multipart/form-data

filesstring[]

Path to the files to be uploaded, e.g. @/path/to/hello_world.pdf. Each file is a separate multipart/form-data. PDF, DOCX, XLSX, PPT, TXT, RTF, CSV, EML, and other file formats supported (reference our Help Center). Max size of 500 MB for all file types. A maximum of 50 files can be uploaded per API request. Beware of HTTPS timeouts if too many large files are sent at a time.

file_pathsstring[]

The desired folder structure for the file(s), e.g. /caselaw/usa/california/sf/hello_world.pdf. This will be reconciled with the names in the provided files paths.

duplicate_mode'skip' | 'replace' | 'keep'

Determines how duplicate file names are handled. skip will not update if a file with the same name already exists. replace will create a new file record (with its own unique file_id) and set its root_file_id to the original file_id. keep will rename the new file to avoid collision (e.g. document (1).pdf).

Example request

{
  "duplicate_mode": "skip"
}

Response

Files successfully uploaded

project_idstring

The project ID.

file_idsstring[]

Array of file IDs that were added to the project.

Changes

No recorded changes to this operation across all 1 revision of this API.