Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Admin Job Management Actions
- Cleanup Old Jobs
- Get Job Stats
- Get Queue Stats
Admin License Management Actions
- Resync License
- Save License Key
- Upload License File
- Get License Info
- Get Installation Id
Admin Server Certificate Actions
- Upload Server Certificate
- Generate Server Certificate
- Get Server Certificate Info
- Is Server Certificate Enabled
- Get Server Certificate
- Delete Server Certificate
Admin Settings Actions
- Get Settings
- Update Settings
- Get Settings Section
- Update Settings Section
- Get Setting Value
- Update Setting Value
- Restart Application
- Get Settings Delta
AI Tools Actions
- Pdf Comment Agent
- Math Auditor Agent
Analysis Actions
- Get Security Info
- Get Page Dimensions
- Get Page Count
- Get Form Fields
- Get Font Info
- Get Document Properties
- Get Basic Info
- Get Annotation Info
Audit Actions
- Get Audit Types
- Get Audit Stats
- Export Audit Data Json
- Export Audit Data
- Get Audit Data
- Cleanup Before
Authentication Actions
- Refresh
- Cancel Mfa Setup
- Enable Mfa
- Disable Mfa
- Disable Mfa By Admin
- Logout
- Login
- Setup Mfa
- Get Current User
Convert Actions
- Convert Ghostscript Inputs To Pdf
- Url To Pdf
- Convert Json To Pdf
- Convert Svg To Pdf
- Process Pdf To XML
- Pdf To Excel
- Process Pdf To Word
- Convert Pdf To Vector
- Process Pdf To RT For TXT
- Convert Pdf To Json
- Export Partial Pdf
- Extract Pdf Metadata
- Clear Cache
- Process Pdf To Presentation
- Pdf To Pdf A
- Process Pdf To Markdown
- Convert To Image
- Process Pdf To HTML
- Convert Pdf To Epub
- Pdf To Csv
- Convert Pdf To Cbz
- Convert Pdf To Cbr
- Markdown To Pdf
- Convert To Pdf
- Html To Pdf
- Process File To PDF
- Convert Eml To Pdf
- Convert Ebook To Pdf
- Convert Cbz To Pdf
- Convert Cbr To Pdf
- Extract Single Page
- Extract Page Fonts
Database Actions
- Import Database
- Create Database Backup
- Delete Last File
- Delete All Files
File Storage Actions
- Get File Metadata
- Update File
- Delete File
- List Files
- Upload File
- Share With User
- Create Share Link
- Download Share Link
- Get Share Link Metadata
- List Accessed Share Links
- List Share Accesses
- Download File
- Revoke User Share
- Leave User Share
- Revoke Share Link
Filter Actions
- Page Size
- Page Rotation
- Page Count
- File Size
- Contains Text
- Contains Image
Forms Actions
- Modify Fields
- Fill Form
- List Fields
- List Fields With Coordinates
- Extract Xlsx
- Extract Csv
- Delete Fields
General Actions
- Split Pdf
- Split Pdf 1
- Split Pdf 2
- Poster Pdf
- Auto Split Pdf 1
- Scale Pages
- Rotate PDF
- Delete Pages
- Remove Images
- Rearrange Pages
- Pdf To Single Page
- Overlay Pdfs
- Merge Multiple Pages Into One
- Merge Pdfs
- Extract Bookmarks
- Edit Text
- Edit Table Of Contents
- Crop Pdf
- Create Booklet Imposition
Info Actions
- Get Weekly Active Users
- Get Uptime
- Get Status
- Get Total Requests
- Get Unique Total Requests
- Get All Post Requests
- Get All Unique Post Requests
- Get Page Loads
- Get Unique Page Loads
- Get All Endpoint Loads
- Get All Unique Endpoint Loads
- Get Health
Invite Actions
- Generate Invite Link
- Cleanup Expired Invites
- Accept Invite
- Validate Invite Token
- List Invite Links
- Revoke Invite Link
Job Management Actions
- Get Job Status
- Cancel Job
- Get Job Result
- Get Job Files
- Download File
- Get File Metadata
Misc Actions
- Metadata
- Unlock PDF Forms
- Extract Header
- Scanner Effect
- Replace And Invert Color
- Repair Pdf
- Rename Attachment
- Remove Blank Pages
- Process Pdf With OCR
- List Attachments
- Flatten
- Extract Images
- Extract Image Scans
- Extract Attachments
- Delete Attachment
- Decompress Pdf
- Optimize Pdf
- Auto Split Pdf
- Extract Header 1
- Add Stamp
- Add Page Numbers
- Overlay Image
- Add Comments
- Add Attachments
Pipeline Actions
- Handle Data
Proprietary UI Data Actions
- Clear All Audit Data
- Get Endpoint Statistics
- Get Teams Data
- Get Team Details Data
- Get Login Data
- Get Database Data
- Get Users
- Get Audit Stats
- Export Audit Data
- Get Audit Events
- Get Event Types
- Get Audit Dashboard Data
- Get Audit Charts
- Get Admin Settings Data
- Get Account Data
Saved Signatures Actions
- List Signatures
- Save Signature
- Update Signature Label
- Delete Signature
Security Actions
- Add Password
- Add Watermark
- Get Pdf Info
- Redact Pdf Auto
- Redact Pdf Manual
- Remove Cert Sign PDF
- Remove Password
- Sanitize PDF
- Sign PDF With Cert
- Timestamp Pdf
- Validate Signature
- Verify PDF
Signature Assets Actions
- Get Signature
Signing Sessions Actions
- Validate Certificate 1
- Sign Document
- Decline Sign Request
- List Sessions
- Create Session
- Add Participants
- Finalize Session
- List Sign Requests
- Get Sign Request Detail
- Get Sign Request Document
- Get Session
- Delete Session
- Get Signed Pdf
- Get Session Pdf
- Remove Participant
Team Actions
- Rename Team
- Delete Team
- Create Team
- Add User To Team
UI Data Actions
- Download Tessdata Languages
- Get Tessdata Languages
- Get Sign Data
- Get Pipeline Data
- Get Ocr Pdf Data
- Get Licenses Data
- Get Home Data
- Get Footer Data
User Actions
- Update User Settings
- Update Api Key
- Register
- Get Api Key
- Complete Initial Setup
- Change Username
- Change Password
- Change Password On Login
- Unlock User
- Save User
- Invite Users
- Delete User
- Change User Enabled
- Change Role
- Change Password For User
- List Users
Workflow Participant Actions
- Validate Certificate
- Submit Signature
- Decline Participation
- Get Session By Token
- Get Document
- Get Participant Details

General → Overlay Pdfs

AI-generated

Summary

Overlay one or more PDF files onto a base PDF either from binary input or server-side stored file, applying overlays according to a specified mode and position (foreground or background).

Inputs

Input Binary Field Name (File Input) — Name of the binary property containing the base PDF file data; used if File ID is not provided.
File Id — ID of a previously stored base PDF file on the server; used instead of binary input for asynchronous processing.
Overlay Files (required) — Array of PDF files to overlay on the base PDF; order and repeat behavior depend on the overlay mode.
Overlay Mode (required) — Determines how overlay files are applied: SequentialOverlay (one after another), InterleavedOverlay (round-robin per page), or FixedRepeatOverlay (fixed repeats per overlay using the counts array).
Counts — Array of integers specifying repeat counts per overlay file, required only for FixedRepeatOverlay mode; length must match overlay files array.
Overlay Position (required) — 0 for overlay in foreground, 1 for overlay as background.

Output shape

a binary PDF file with overlays applied

The output is a single binary file representing the base PDF with the specified overlay PDFs applied according to the chosen mode and position. The operation supports batch processing controlled by request options but always returns the combined PDF for each input item.

Stirling PDFInstall