Vaults

Confirm vault upload result

Changed on

Confirm whether a direct-to-S3 vault upload succeeded or failed. This endpoint emits vault.upload.completed or vault.upload.failed events and is idempotent for repeated confirmations. Conditional fields: when success=true, sizeBytes is required; when success=false, errorCode and errorMessage are required. These rules are enforced server-side with specific 400 responses.

post/vault/{id}/upload/{objectId}/confirm

Request

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

Path parameters

idstring required

Vault ID

objectIdstring required

Vault object ID

Request body

successboolean required

Whether the upload succeeded

sizeBytesinteger

Uploaded file size in bytes, including zero. Required when success=true and verified against S3. Empty files can be stored and transferred, but cannot be ingested.

etagstring

S3 ETag for the uploaded object (optional if client cannot access ETag header). Only meaningful when success=true.

autoIngestboolean

When true and the object was uploaded with auto_index, trigger ingestion immediately after a successful confirmation (no separate ingest call needed). The ingest outcome is reported in the ingest response field; an ingest failure does not fail the confirmation.

errorCodestring

Client-side error code. Required when success=false.

errorMessagestring

Client-side error message. Required when success=false.

Response

Confirmation recorded

vaultIdstring
objectIdstring
status'completed' | 'failed'
alreadyConfirmedboolean

Changes

    • breaking

      added the new required request property

    • breaking

      removed subschema #1: VaultConfirmUploadSuccess subschema #2: VaultConfirmUploadFailure from the request body oneOf list

    • breaking

      the request's body type changed from no type to object

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status