SearchCtrl+K

PDF Extract Pages API Reference

Extract specific pages or page ranges from a PDF file and return them as a new PDF.

POST

https://api.apifreaks.com/v1.0/pdf/extract-pages

The PDF Extract Pages API allows you to select individual pages or ranges to create focused sub-documents from larger PDFs. You can also use keywords like even, odd, or all for batch extraction.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl --location --request POST 'https://api.apifreaks.com/v1.0/pdf/extract-pages' \
--header 'X-apiKey: API-KEY' \
--form 'file=@"/path/to/file.pdf"'

Response

{
  "taskId": "04a06cd5-158d-4191-a45b-6f58249c599d",
  "inputIds": [
    "7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f"
  ]
}

API Request Parameters

The following parameters can be used in your API requests. File upload and webhook parameters are passed as multipart form data and query parameters.

file_idoptionalString

The unique ID of a file already present on our server. Use PDF Files API to see your files. Check file metadata using File Status API

destroyoptionalBooleandefault: false

Set to true if you want to permanently delete the original file after processing.

pagesrequiredString

Pages to extract: comma-separated numbers/ranges (e.g., 1-4,9-5,16-last) or keywords listed here:

even (even pages)
odd (odd pages)
all (all pages)
last (use with pages: 5-last)

Note: Only last can combine with page numbers. Multiple pages param can be passed at once to get multiple output files.

separatedoptionalBooleandefault: false

If set to true, extracts each of the given pages as a separate PDF. Output is delivered as a ZIP file containing individual PDF files for each extracted page.

outputoptionalString

Optionally specify a custom name for the output file (without extension).

webhook_urloptionalString

Provide a URL to receive a webhook notification when the task is completed. The notification will include the task status and file ID(s) of the output.

webhook_failure_notificationoptionalBooleandefault: false

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

Request Headers

Optional custom headers for webhook authorization.

X-Webhook-AuthorizationoptionalString

Custom authorization header sent with the webhook request. Format: Key:Value (e.g., Authorization:Bearer token123).

API Response Schema

A successful request returns a 200 OK response with a JSON object containing the task ID and input file IDs.

taskId

Stringmandatory

Unique identifier for the PDF task, used to check status.

inputIds

Array<String>optional

Array of file IDs referencing input files used for the task. Not returned when destroy=true.

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Please provide a valid file ID

400

Please select and upload a valid file. Ensure you are not submitting empty form fields or text data instead of a file.

415

The provided file type is not supported. Refer to the documentation for valid file types.