> ## Documentation Index
> Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Split Document
> Split or extract pages from a PDF document into one or more output files and return a temporary download URL.
This endpoint requires the following scope:
`pdf:files`
## OpenAPI
````yaml tabs/api-reference/lumin-openapi.yaml POST /documents/split
openapi: 3.1.0
info:
version: 1.0.0
title: Lumin API Reference
description: >
The Lumin API Reference provides a comprehensive set of tools to integrate
document workflows — including editing, eSignatures, and automation — into
your applications.
Useful links:
- [Document Repository](https://github.com/luminpdf/luminsign-docs)
- [API
Definition](https://github.com/luminpdf/luminsign-docs/blob/main/openapi.yaml)
- [Authentication Guide](/tabs/guides/authentication/overview)
termsOfService: https://www.luminpdf.com/terms-of-use/
contact:
name: API Support
email: integration@luminpdf.com
url: https://help.luminpdf.com
servers:
- url: https://api.luminpdf.com/v1
description: Production server
security: []
tags:
- name: Signature Requests
description: Everything about Signature Requests
- name: Users
description: Everything about Users
- name: Templates
description: Everything about Templates
- name: Documents
description: Everything about Documents
- name: Workspaces
description: Everything about Workspaces
- name: Agreements
description: Everything about Agreements
paths:
/documents/split:
post:
tags:
- Documents
summary: Split Document
description: >
Split or extract pages from a PDF document into one or more output files
and return a temporary download URL.
The document can be specified by a Lumin document ID or by a publicly
accessible file URL.
Two split methods are supported:
- `ranges` — Extract specific page ranges into separate output files
(e.g., pages 1–3 as one file, pages 7–9 as another).
- `fixed_size` — Split the document into equal-sized parts of N pages
each.
The output file is **temporary** — the `signed_url` expires after 30
minutes. To persist the result, download and re-upload via [Create
Document](/tabs/api-reference/api/documents/create-document).
**Output packaging:**
- Single output file → the `signed_url` points directly to a PDF.
- Multiple output files → the `signed_url` points to a ZIP archive
containing all PDFs.
Password-protected documents cannot be split.
**File URL restrictions:** Only URLs from allowed domains are accepted
(`api.luminpdf.com`, `*.s3.amazonaws.com`, `*.s3.*.amazonaws.com`).
Redirecting URLs are not supported.
**Input priority:** If both `document_id` and `file_url` are provided,
`document_id` takes priority and `file_url` is ignored.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSplitRequest'
examples:
ranges:
summary: Split by page ranges
value:
document_id: 695dd6880d951f4de70a7c5d
method: ranges
ranges:
- 1-3,5
- 7-9
- '12'
fixed-size:
summary: Split by fixed page count
value:
document_id: 695dd6880d951f4de70a7c5d
method: fixed_size
pages_per_file: 5
document_name: Quarterly Report
responses:
'200':
description: Returns a temporary download URL for the split result (PDF or ZIP).
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSplitResponse'
example:
signed_url: https://files.luminpdf.com/download/split-abc123?token=xyz789
expires_at: 1755526530000
4XX:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKey: []
- BearerAuth:
- pdf:files
components:
schemas:
DocumentSplitRequest:
type: object
required:
- method
properties:
document_id:
type: string
description: >
Lumin document ID of the PDF to split.
Required when `file_url` is not provided. Takes priority if both are
provided.
To obtain a document ID, upload the file to Lumin first using
[Upload
Document](/tabs/api-reference/api/documents/create-document).
file_url:
type: string
format: uri
description: >
Publicly accessible URL of the PDF file to split.
Required when `document_id` is not provided. Ignored if
`document_id` is also provided.
method:
type: string
enum:
- ranges
- fixed_size
description: |
Split method.
- `ranges` — Extract specific page ranges into separate files.
- `fixed_size` — Split into parts of a fixed number of pages.
ranges:
type: array
description: |
List of page range expressions. Each entry produces one output file.
Required when `method` is `ranges`.
items:
type: string
pages_per_file:
type: integer
minimum: 1
description: >
Number of pages per output file.
Required when `method` is `fixed_size`. Must not produce more than
10,000 output files.
document_name:
type: string
minLength: 1
maxLength: 255
description: >-
Base name for the output files. Defaults to `extracted_{original
document name}`.
DocumentSplitResponse:
type: object
required:
- signed_url
- expires_at
properties:
signed_url:
type: string
format: uri
description: >-
Temporary HTTPS URL to download the result. Points to a PDF (single
file) or ZIP archive (multiple files). Expires after 30 minutes.
expires_at:
type: integer
format: unix-epoch
description: >-
Unix epoch timestamp (in milliseconds) when `signed_url` becomes
invalid.
Error:
type: object
required:
- error_code
- error_message
properties:
error_code:
type: string
description: The system error code.
error_message:
type: string
description: The human-readable error message.
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-Key
description: >
Provide your API key in the `X-API-Key` header, e.g., `X-API-Key:
YOUR_API_KEY`.
BearerAuth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.luminpdf.com/oauth2/auth
tokenUrl: https://auth.luminpdf.com/oauth2/token
scopes:
openid: >-
Retrieve basic identity details (username, email, profile
picture).
offline_access: Request a refresh token for long-lived access. Private apps only.
profile.read: View basic user profile information.
workspaces: View and manage Workspaces and Spaces.
workspaces.read: View information about the authenticated user's Workspace.
templates: View and manage templates in a Workspace.
pdf:files: Create, edit, and delete PDF files in a Workspace.
pdf:files.read: Retrieve PDF documents stored in a Workspace.
sign:requests: Create, update, or view signature requests.
sign:requests.read: Retrieve signature requests.
agreements: Create, update, or delete AgreementGen documents.
description: >
OAuth 2.0 authorization code flow. Provide your access token in the
`Authorization` header, e.g., `Authorization: Bearer `. See the
[OAuth 2.0 guide](/tabs/guides/authentication/oauth2) for details.
````