---
title: "Start import job"
method: POST
path: "/import/import-start"
tags: ["Document AI — Import & Migration"]
---

# Start import job

`POST /import/import-start`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/import/import-start`
- Auth: HTTP bearer

Start an import batch. Returns progress_percent and status. Call repeatedly until completed.

## Request body

- object
  - `job_id` integer, required: Identify the import jobs that have started (status must be scan_complete)

## Response `200`

Success

- object: Import started
  - `status` 'success' | 'error': Request status (ok/error)
  - `message` string: Status message
  - `import` object: Import
    - `import_id` string: Import id
    - `status` 'pending' | 'scanning' | 'processing' | 'completed' | 'failed' | 'cancelled': Request status (ok/error)
    - `total_files` integer: Total number of files
    - `processed_files` integer: Processed files
    - `failed_files` integer: Failed files
    - `progress_percent` number: Progress percent
    - `created_at` string, date-time: Erstellungszeitpunkt
  - `processing_time` string: Request processing time (e.g. "123.45ms")
  - `data` string: Data
  - `job_id` string: Job id
  - `total_files_imported` string: Total files imported

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)