Plumsail Documents API Documentation
This is the complete API documentation for connecting to the Plumsail Documents API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Plumsail Documents: Generate, convert, and protect documents and PDFs. Keep reading to get started.
Quickstart
Before you run your first Plumsail Documents request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Plumsail Documents connection — create or choose one in Connections. Note its
connectionId.
Every Plumsail Documents action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/plumsailDocuments/actions/{actionSlug}/runYou need a MindCloud API Key and a Plumsail Documents connection. Then call an action such as Get Profile Info:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/plumsailDocuments/actions/get-profile-info/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Plumsail Documents account. See Plumsail Documents API Authentication for the full flow and how to get your connection credentials.
Plumsail Documents actions
All 22 published actions for this Plumsail Documents version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Watermark to PDF
- POSTCompress PDF Document
- POSTConvert Any to PDF
- POSTConvert CSV to XLSX
- POSTConvert DOC to DOCX
- POSTConvert DOCX to PDF
- POSTConvert HTML to PDF
- POSTConvert PPT to PPTX
- POSTConvert PPTX to PDF
- POSTConvert XLS to XLSX
- POSTConvert XLSX to PDF
- POSTCreate DOCX Document
- POSTCreate HTML Document
- POSTCreate PPTX Document
- POSTCreate XLSX Document
- POSTExtract Text from PDF
- POSTFill DOCX Merge Fields
- POSTFill PDF Form
- GETGet PDF Form
- GETGet Profile Info
- POSTProtect PDF Document
- POSTSplit PDF
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.