Skip to main content
New to Corsair? See API access, authentication, and error handling.

Convert

htmlToPdf

convert.htmlToPdf Render HTML content into a PDF Risk: destructive
Input Output

ocrPdf

convert.ocrPdf Run OCR on a scanned PDF to make its text editable; the API answers a job, so poll jobs.status for the file Risk: destructive
Input Always runs as a job: poll jobs.status with the jobId for the file. ocrWhenNeeded goes out as the string the API expects. Output

pdfToWord

convert.pdfToWord Convert a PDF to a Word document; the API answers a job, so poll jobs.status for the file Risk: destructive
Input Output

Extract

pdfFormData

extract.pdfFormData Extract the values of filled PDF form fields Risk: read
Input Answers formData: field values keyed by field name. Output

tableFromPdf

extract.tableFromPdf Extract tables from a PDF Risk: read
Input Answers tableList: one entry per page with its table rows. Output

Jobs

status

jobs.status Poll a job (isAsync, or PDF-to-Word and OCR, which always run as jobs); a finished job answers its file Risk: read
Input GETs GetActionStatus with the job id. A finished job answers its file (isFinished true, fileContent); a running one answers its status. Output

Pdf

compress

pdf.compress Compress a PDF with a documented profile (Max, Web, Print, Default) Risk: destructive
Input optimizeProfile values: Max, Web, Print, Default. Default is mapped to Max server-side; an unknown value fails with 400 Invalid Optimization Profile. Output

deletePages

pdf.deletePages Return a copy of a PDF without the given pages; the source file is not changed Risk: destructive
Input Answers a new PDF without the pages; the source file is not changed. Marked destructive because each call uses a billed API call. Output

extractPages

pdf.extractPages Extract the given pages into a new PDF Risk: destructive
Input Output

getInfo

pdf.getInfo Read PDF metadata: page count, dimensions, author and more Risk: read
Input Calls GetPdfMetadata (the documented GetPdfInformation route answers 404). Reads page count, size, author, version and more. Output

merge

pdf.merge Merge multiple PDFs into one; array order is the merge order Risk: destructive
Input docContent is an array and the array order is the merge order. The answer is the merged PDF. Output

split

pdf.split Split a PDF after a page, every N pages, after listed pages or by page ranges; the parts come back in documents Risk: destructive
Input splitAction picks after a page, every N pages, after listed pages or by ranges; the parts come back in documents. Output