Scan Documents
SupportFeedbackDashboard
PDF Operations

Extract pages from a PDF file

Creates a task to extract specific pages from a PDF file into a new PDF file.

POST
/v1/pdf-operations/extract-pages

Authorization

x-api-key
<token>

API Key for authentication

In: header

Request Body

application/jsonOptional
inputrequired
string

The id of the file to operate on.

name
string

The name of the file

Minimum length: 1Maximum length: 30
pagesrequired
string

Page range (e.g., 2-7), a comma-separated list (e.g., 2,3,7) of pages.

Response Body

The response of an extract task

TypeScript Definitions

Use the response body type in TypeScript.

responserequired
Extract Pages Response

The response of an extract task

curl -X POST "https://api.scan-documents.com/v1/pdf-operations/extract-pages" \
  -H "x-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "file_avyrvozb9302uwhq",
    "name": "File Name",
    "pages": "2-7"
  }'
{
  "id": "task_euyrvozb9302uwhq",
  "operation": "extract-pages",
  "parameters": {
    "input": "file_avyrvozb9302uwhq",
    "name": "File Name",
    "pages": "2-7"
  },
  "status": "completed",
  "result": {
    "generated_files": [
      {
        "id": "file_euyrvozb9302uwhq",
        "name": "Example document",
        "type": "application/pdf",
        "properties": {
          "size": 1024,
          "page_count": 10
        },
        "task_id": "task_euyrvozb9302uwhq",
        "created_at": "2021-05-01T12:00:00Z"
      }
    ]
  },
  "created_at": "2021-05-01T12:00:00Z",
  "updated_at": "2021-05-01T12:00:00Z"
}

Warp (perspective correct) an image POST

Creates a task to apply perspective correction (warp) to an image based on detected document boundaries.

Merge files into PDF POST

Creates a task to merge multiple PDF and/or image files into a single PDF file.