v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB

Vaults

Generate presigned upload URL for vault file

Generate a presigned URL for uploading files directly to a vault's S3 storage. After uploading to S3, confirm the upload result via POST /vault/:vaultId/upload/:objectId/confirm before triggering ingestion.

post/vault/{id}/upload

Path parameters

idstring required

Vault ID to upload the file to

Request body

filenamestring required

Name of the file to upload

contentTypestring required

MIME type of the file (e.g., application/pdf, image/jpeg)

metadataobject

Additional metadata to associate with the file

auto_indexboolean

Whether to automatically process and index the file for search

sizeBytesinteger

File size in bytes (optional, max 5GB for single PUT uploads). When provided, enforces exact file size at S3 level.

pathstring

Optional folder path for hierarchy preservation. Allows integrations to maintain source folder structure from systems like NetDocs, Clio, or Smokeball. Example: '/Discovery/Depositions/2024'

Response

Upload URL generated successfully

objectIdstring

Unique identifier for the uploaded object

uploadUrlstring

Presigned URL for uploading the file

expiresInnumber

URL expiration time in seconds

s3Keystring

S3 object key for the file

pathstring nullable

Folder path for hierarchy if provided

auto_indexboolean

Whether the file will be automatically indexed

enableIndexingboolean

Whether the vault supports indexing. False for storage-only vaults.

next_stepstring nullable

Next API endpoint to call for processing