CAcasemark
Vault Objects

Append PDF vault objects onto an existing PDF vault object

Changed on

Merges one or more PDF vault objects onto the end of an existing PDF vault object. Sync mode is the default and overwrites the target in place before returning. Async mode returns 202 immediately and reports completion through vault.object.append webhooks. Optionally rewrites citation links in the original target into internal PDF jumps and adds back links on appended pages. The target object’s ingestion state is not affected; appended pages are not searchable.

post/vault/{id}/objects/{objectId}/append

Request

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

Path parameters

idstring required

Vault ID

objectIdstring required

ID of the vault object to append onto

Headers

Idempotency-Keystring

Required when mode is async; stable key for safely retrying the append

Request body

mode'sync' | 'async'

Use async to return immediately and receive completion through vault.object.append webhooks.

appendObjectIdsstring[] required

Vault object IDs whose pages will be appended onto the target object, in order. Must not include the target object itself. Sync mode accepts at most 20; async mode accepts at most 1000.

rewriteLinksboolean

When true, rewrites links in the target object to internal PDF jumps when the URL contains exactly one appended object ID as a standalone query parameter value or decoded path segment.

backLinksboolean

Adds back links on appended pages

backLinksTextstring

Label text for the back link. Used only when backLinks is true and rendered centered at the bottom of each appended page.

clientReferencestring

Caller-provided correlation value returned in async responses and webhooks.

Response

Target object updated successfully

idstring
vaultIdstring
filenamestring
contentTypestring
sizeBytesinteger
checksumstring
ingestionStatusstring
pageCountinteger
appendedPageStartinteger

First 1-indexed page added by this append operation.

appendedPageEndinteger

Last 1-indexed page added by this append operation.

objectIdstring
batesobject
metadataobject
downloadUrlstring
expiresIninteger
createdAtstring date-time

Changes