Document Platform

Merge multiple PDF documents into a single PDF

post/customers/{customerId}/buildings/{buildingId}/documents/merge

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/documents/merge
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Request body

documentIdsstring[] required

Array of document IDs to merge (2-100 documents)

mergedFilenamestring

Optional filename for the merged PDF (default: merged_N_documents_YYYY-MM-DD.pdf)

archiveOriginalsboolean

Whether to archive the original documents after merging (default: false)

categoryIdstring

Optional category code for merged document. If provided, uses this category. If omitted and first document has a category, inherits from first document. Otherwise, triggers AI classification.

folderIdstring uuid

Optional folder ID for merged document. If omitted, uses first document's folder.

Response

Default Response

mergedDocumentobject
archivedDocumentsstring[]
errorsstring[]

Changes

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