Diffchecker API
Last Revised: September 18th, 2024
At the moment there exists 3 HTTP endpoints for computing text diffs, PDF diffs, and Image diffs, all with varying output types. We plan to gradually add more input and output types as we move forward with the API (e.g. Excel, etc).
You may find the following resources helpful when dealing with PDF and image diffs:
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
- https://developer.mozilla.org/en-US/docs/Web/API/FormData
Authentication
There are two ways of interacting with the Diffchecker API:
- Email: just pass your email as a query string parameter. This method does not require you to have a Diffchecker account and will allow you to make as many diffs as free tier limits allow.
- API Key: every paid subscriber gets their own API key, which needs to be passed as the request's X-Api-Key header. This will allow you to make as many diffs as your paid plan allows.
When both are provided, email gets ignored in favor of the API key. The examples in these docs assume you are authenticating via email.