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

Comparisons

create

comparisons.create Compare two documents given by URL (PDF, Word, PowerPoint, RTF or text). Uses one comparison from the plan quota. Risk: destructive
Input
Output

delete

comparisons.delete Delete a comparison and its documents from Draftable. Risk: destructive
Input Draftable answers a successful delete with an empty 204; the operation then returns { identifier, deleted: true }. Output

get

comparisons.get Get one comparison: both documents, page counts, and whether it is ready or failed. Risk: read
Input Output

getViewerUrl

comparisons.getViewerUrl Get a link to view a comparison in the Draftable viewer, signed for a limited time unless the comparison is public. Risk: read
Input Output

list

comparisons.list List the comparisons on the Draftable account. Risk: read
Input Omit limit or offset to take the service default. Output

Exports

create

exports.create Start a PDF export of a comparison. Poll exports.get until ready, then download its url. Risk: write
Input Output

get

exports.get Get an export: whether it is ready and the URL to download the PDF. Risk: read
Input Output