Plumsail Documents

App · 20 actions

Generate documents from templates, convert files and process PDFs.

Actions

ActionWhat it does
Convert csv to xlsxConverts a CSV file, uploaded or from a public URL, to an Excel XLSX workbook, with options for the header row, delimiter, locale and column mappings.
Convert doc to docxConverts an older Word DOC file, uploaded or from a public URL, to the newer DOCX format.
Convert docx to pdfConverts a Word DOCX file, uploaded or from a public URL, to PDF.
Convert html to pdfConverts an HTML file, uploaded or from a public URL, to PDF with the page size, orientation and margins you choose.
Convert pdf to textExtracts the text from a PDF, uploaded or from a public URL, as plain text or HTML, optionally for a range of pages or with a password.
Convert ppt to pptxConverts an older PowerPoint PPT file, uploaded or from a public URL, to the newer PPTX format.
Convert pptx to pdfConverts a PowerPoint PPTX file, uploaded or from a public URL, to PDF.
Convert xls to xlsxConverts an older Excel XLS file, uploaded or from a public URL, to the newer XLSX format.
Convert xlsx to pdfConverts an Excel XLSX file, uploaded or from a public URL, to PDF.
Generate docxFills a Word DOCX template, uploaded or from a public URL, with the data you give.
Generate htmlFills an HTML template, uploaded or from a public URL, with the data you give.
Generate pptxFills a PowerPoint PPTX template, uploaded or from a public URL, with the data you give.
Generate xlsxFills an Excel XLSX template, uploaded or from a public URL, with the data you give.
Get profileGets the connected Plumsail account's profile, including the short user ID needed to start a process.
List process tokensLists the tokens a process's template expects, by its process ID, so you know what data to send when starting it.
List processesLists the document generation processes in your Plumsail account, with each process's ID and name.
Pdf compressMakes a PDF, uploaded or from a public URL, smaller, optionally without losing quality.
Pdf protectAdds passwords to a PDF and sets whether readers may print, change, copy from or annotate it.
Pdf splitSplits a PDF, uploaded or from a public URL, by extracting a page range, into chunks of a set size, or by its bookmarks.
Start processStarts a document generation process by its ID with the data to fill its template, and returns links to the documents it produces.

Convert csv to xlsx

Converts a CSV file, uploaded or from a public URL, to an Excel XLSX workbook, with options for the header row, delimiter, locale and column mappings.

Inputs

Has header recordshas_header_recordstrue/false
Has header records.
Delimiterdelimitertext
Delimiter.Default: ,.
Localelocaletext
Locale.One of: aa-DJ, aa-ER, aa-ET, af-NA, af-ZA, agq-CM, ak-GH, am-ET, ar-001, ar-AE, and 549 more. Default: en-US.
Limitlimitnumber
Limit.
Mappingsmappingstext
Dictionary of parameters to rename headers and specify types for columns, where key is the header or the index of the column in the CSV. Example: {"Header1": {"Header": "NewHeader1", "Type": "Text"}, "3": {"Type": "TwoDecimal"}} Column types: General, Text, Integer, TwoDecimal, ThousandInteger, ThousandTwoDecimal, IntegerPercentage,TwoDecimalPercentage, Scientific, ShortDate, ShortDateTime, LongDate
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert doc to docx

Converts an older Word DOC file, uploaded or from a public URL, to the newer DOCX format. Returns a link to the new file.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert docx to pdf

Converts a Word DOCX file, uploaded or from a public URL, to PDF. Returns a link to the PDF.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert html to pdf

Converts an HTML file, uploaded or from a public URL, to PDF with the page size, orientation and margins you choose. Returns a link to the PDF.

Inputs

Sizesizetext
Size.One of: A4, Letter, LetterSmall, Tabloid, Ledger, Legal, Statement, Executive, A2, A3, and 4 more.
Orientationorientationtext
Orientation.One of: Portrait, Landscape.
Marginsmarginstext
Margins.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert pdf to text

Extracts the text from a PDF, uploaded or from a public URL, as plain text or HTML, optionally for a range of pages or with a password.

Inputs

Result typeresult_typetext
Result type.One of: Raw, HTML.
Passwordpasswordtext
Password.
Start pagestart_pagenumber
Start page.
End pageend_pagenumber
End page.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert ppt to pptx

Converts an older PowerPoint PPT file, uploaded or from a public URL, to the newer PPTX format. Returns a link to the new file.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert pptx to pdf

Converts a PowerPoint PPTX file, uploaded or from a public URL, to PDF. Returns a link to the PDF.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert xls to xlsx

Converts an older Excel XLS file, uploaded or from a public URL, to the newer XLSX format. Returns a link to the new file.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Convert xlsx to pdf

Converts an Excel XLSX file, uploaded or from a public URL, to PDF. Returns a link to the PDF.

Inputs

Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Generate docx

Fills a Word DOCX template, uploaded or from a public URL, with the data you give. Returns a link to the finished document, as DOCX or PDF.

Inputs

Localelocaletext
Locale.One of: aa-DJ, aa-ER, aa-ET, af-NA, af-ZA, agq-CM, ak-GH, am-ET, ar-001, ar-AE, and 549 more. Default: en-US.
Datadataobject
Data.
Output typeoutput_typetext
Output type.
Timezonetimezonetext
Timezone.One of: Australia/Darwin, Australia/Sydney, Australia/Melbourne, Asia/Kabul, America/Anchorage, America/Juneau, America/Metlakatla, America/Nome, America/Sitka, America/Yakutat, and 587 more.
Engineenginetext
Engine.One of: Classic, Modern. Default: Modern.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Generate html

Fills an HTML template, uploaded or from a public URL, with the data you give. Returns a link to the finished HTML file.

Inputs

Localelocaletext
Locale.One of: aa-DJ, aa-ER, aa-ET, af-NA, af-ZA, agq-CM, ak-GH, am-ET, ar-001, ar-AE, and 549 more. Default: en-US.
Datadataobject
Data.
Timezonetimezonetext
Timezone.One of: Australia/Darwin, Australia/Sydney, Australia/Melbourne, Asia/Kabul, America/Anchorage, America/Juneau, America/Metlakatla, America/Nome, America/Sitka, America/Yakutat, and 587 more.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Generate pptx

Fills a PowerPoint PPTX template, uploaded or from a public URL, with the data you give. Returns a link to the finished presentation, as PPTX or PDF.

Inputs

Localelocaletext
Locale.One of: aa-DJ, aa-ER, aa-ET, af-NA, af-ZA, agq-CM, ak-GH, am-ET, ar-001, ar-AE, and 549 more. Default: en-US.
Datadataobject
Data.
Output typeoutput_typetext
Output type.
Timezonetimezonetext
Timezone.One of: Australia/Darwin, Australia/Sydney, Australia/Melbourne, Asia/Kabul, America/Anchorage, America/Juneau, America/Metlakatla, America/Nome, America/Sitka, America/Yakutat, and 587 more.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Generate xlsx

Fills an Excel XLSX template, uploaded or from a public URL, with the data you give. Returns a link to the finished workbook, as XLSX or PDF.

Inputs

Localelocaletext
Locale.One of: aa-DJ, aa-ER, aa-ET, af-NA, af-ZA, agq-CM, ak-GH, am-ET, ar-001, ar-AE, and 549 more. Default: en-US.
Datadataobject
Data.
Output typeoutput_typetext
Output type.
Timezonetimezonetext
Timezone.One of: Australia/Darwin, Australia/Sydney, Australia/Melbourne, Asia/Kabul, America/Anchorage, America/Juneau, America/Metlakatla, America/Nome, America/Sitka, America/Yakutat, and 587 more.
Engineenginetext
Engine.One of: Classic, Modern. Default: Modern.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Get profile

Gets the connected Plumsail account's profile, including the short user ID needed to start a process.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List process tokens

Lists the tokens a process's template expects, by its process ID, so you know what data to send when starting it.

Inputs

Processprocess_idtextRequired
Process ID.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List processes

Lists the document generation processes in your Plumsail account, with each process's ID and name.

Inputs

None.

Outputs

datalist
Response.
Example output
{
  "data": []
}

Pdf compress

Makes a PDF, uploaded or from a public URL, smaller, optionally without losing quality. Returns a link to the compressed PDF.

Inputs

Lossless modelossless_modetext
Lossless mode.One of: On, Off. Default: On.
Passwordpasswordtext
Password.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Pdf protect

Adds passwords to a PDF and sets whether readers may print, change, copy from or annotate it. Returns a link to the protected PDF.

Inputs

Allow printingallow_printingtrue/falseRequired
Allow printing.
Allow modificationallow_modificationtrue/falseRequired
Allow modification.
Allow extractallow_extracttrue/falseRequired
Allow extract.
Allow annotateallow_annotatetrue/falseRequired
Allow annotate.
New owner passwordnew_owner_passwordtext
New owner password.
New user passwordnew_user_passwordtext
New user password.
Passwordpasswordtext
Password.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "link": "example"
  }
}

Pdf split

Splits a PDF, uploaded or from a public URL, by extracting a page range, into chunks of a set size, or by its bookmarks. Returns links to the new files.

Inputs

Typetypetext
How to split the fileOne of: ExtractPages, SplitIntoChunks, SplitByBookmarks. Default: ExtractPages.
Extract rangeextract_rangetext
Page or pages range. Example: 2, 4-7, 9-*, last(3). Required for ExtractPages split type
Pages in chunkpages_in_chunknumber
Number of pages in one chunk. Optional. 1 - default number of pages. Used for SplitIntoChunks split type
Chunks rangechunks_rangetext
Pages range. Optional. Apply to the specified pages range. E.g. 3-8. Used for SplitIntoChunks split type
Bookmark depthbookmark_depthnumber
Bookmark depth. Optional. Depth of bookmarks levels to track. 1 - default. Used for SplitByBookmarks split type
Use bookmarks for file namesuse_bookmarks_for_file_namestrue/false
Use bookmarks as filenames. Optional. Shouldn't be "Yes" if Filename Prefix is specified. Used for SplitByBookmarks split type
Filename prefixfilename_prefixtext
Filename Prefix. Optional. Output files will have this prefix followed by an index number for name. Won't take effect if UseBookmarksForFileNames is "true"
Passwordpasswordtext
Password.
Filefiletext
File.
File urlfile_urltext
File url.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "links": []
  }
}

Start process

Starts a document generation process by its ID with the data to fill its template, and returns links to the documents it produces.

Inputs

Short user IDshort_user_idtextRequired
Short user ID.
Processprocess_idtextRequired
Process ID.
DatadataobjectRequired
Data.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

On this page