CAcasemark
Vaults

Generate presigned upload URL for vault file

Changed on

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

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/vault/{id}/upload
  • Auth
    HTTP bearer

Path parameters

idstring required

Vault ID to upload the file to

Headers

Idempotency-Keystring

Optional stable key for safely retrying upload initialization

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

file_originobject

Optional client-defined provenance metadata. Returned with the object and queryable through the object-list API.

auto_indexboolean

Whether to automatically process and index the file for search

is_ai_generatedboolean

Marks the file as AI-generated work product (e.g. uploaded by an agent) rather than a user-provided source document. Persisted on the object and returned by object listings so clients can distinguish provenance.

sizeBytesinteger

File size in bytes (optional, including zero, max 5GB for single PUT uploads). When provided, enforces exact file size at S3 level. Empty files can be stored and transferred, but cannot be ingested.

pathstring

Optional folder path, excluding the filename, 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 nullable

Presigned URL for uploading the file

alreadyUploadedboolean

True when this idempotency key already identifies a confirmed upload

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

is_ai_generatedboolean

Whether the file is marked as AI-generated work product

file_originobject nullable

Client-defined provenance metadata associated with the file

enableIndexingboolean

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

next_stepstring nullable

Next API endpoint to call for processing

Changes

  • a21d188f4b21Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property's min was decreased from 1.00 to 0.00

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status