Document AI — DMS

Export document list

Export Documents Bulk export documents as ZIP archive. Options: - Specific POFIDs - All from workspace

post/documents/documents-export

Request

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

Request body

selected_pofidsstring[] required

JSON array of POFIDs to export.

export_format'excel' | 'xlsx' | 'csv' | 'json' | 'pdf' | 'zip' required

Export format: excel/xlsx (spreadsheet), csv, json, pdf. Legacy alias zip maps to json bundle with original files (use archive_format for zip/7z).

selected_fieldsstring[] required

JSON array of field names to export (e.g. ['file_name', 'created_datetime', 'file_size']).

field_orderstring[]

Optional column order for the export.

include_original_filesboolean

Include original files in the export bundle (typically with export_format=json or zip alias).

include_ocr_textboolean

Include OCR-extracted text in the export.

include_ocr_bounding_boxesboolean

Include OCR bounding boxes (position data) in the export.

archive_format'zip' | '7z'

Archive format for file exports (zip or 7z).

excel_optionsobject

Optional Excel-specific settings (column width, header formatting etc.).

filename_patternstring

Optional naming schema for original files in the ZIP/7z bundle. Use {field_key} tokens plus separators _ - . and space, e.g. {date_issued}{document_number}{publisher_name}_{document_type}. Empty keeps the original filename (DMS file_name). Applied only when original files are included. Invalid patterns return HTTP 400 INVALID_FILENAME_PATTERN.

Response

Success

status'success' | 'error' required

HTTP-Level Status

job_idstring required
messagestring

Menschenlesbare Statusmeldung

pipelinestring
operationstring

Ausgefuehrte Operation

processing_timestring

Gesamte Verarbeitungszeit inkl. Queue (Format: 123.45ms)

Changes

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