Document AI — Import & Migration

Create import job

Create an import job.

post/import/import-create

Request

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

Request body

workspace_idinteger required

Target workspace into which the files will be imported

source_type'sftp' | 'local_upload' | 'watchfolder' required

Import source: sftp, local_upload, or watchfolder.

source_configobject required

Source-specific connection object (see endpoint description).

include_subfoldersboolean

Include subfolders (default: true)

file_patternstring

File filter pattern, e.g. ".pdf" (default: "")

ai_processingboolean

Enable AI processing (derived from workspace setting if omitted)

ai_tier'basic' | 'premium' | 'ultra'

AI processing tier (basic, premium, ultra)

max_file_size_mbinteger

Optional max file size in MB (default server limit).

processing_lane'no_sla' | 'sla_24h' | 'sla_12h' | 'sla_6h' | 'sla_1h' | 'instant'

Start-SLA lane (wait-to-start guarantee, not completion). Values: no_sla (fair use ×1), sla_24h (×1.5), sla_12h (×2), sla_6h (×3), sla_1h (×4), instant (×5 interactive start). Prefer this over legacy numeric priority. If omitted: workspace default_processing_lane, else no_sla.

Response

Success

status'success' | 'error'

Request status (ok/error)

messagestring

Status message

processing_timestring

Request processing time (e.g. "123.45ms")

Changes

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