Document AI — DMS

Create document folder

Bundle at least two existing documents (POFIDs) into a stapled folder/heft in the Headless DMS. This is not an empty directory create — it links documents that already exist.

post/documents/folder-create

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/folder-create
  • Auth: HTTP bearer

Request body

pofidsstring[] required

List the PaperOffice-Document IDs (POFIDs) that are to be summarized in the folder. At least 2 are required.

folder_namestring

Name of the document folder. If empty, it is automatically generated (e.g., '3 linked Documents').

folder_type'staple' | 'binder'

Folder type: staple (stapled stack) or binder (ring binder).

folder_descriptionstring

Optional description for the document folder.

parent_pofidstring

POFParent document ID. Default: first document in the list.

Response

Success

status'success' | 'error' required

HTTP-Level Status

job_idstring required
messagestring

Human-readable status message

pipelinestring

Name of the executed pipeline

operationstring

Executed operation

processing_timestring

Total processing time including queue (format: 123.45ms)

Changes

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