TABLE OF CONTENTS
What is an API?
An Application Programming Interface (API) is a mechanism that enables two software components to communicate and transfer data via a set of definitions and protocols. A request is sent to the API, which retrieves data and returns it to the user.
Smartbox.ai API
The Smartbox.ai API enables the integration of the service with other software platforms. Through this mechanism Smartbox's functionality can be leveraged and customised to fit any specific requirements, helping to streamline processes and increase productivity.
By communicating with the available endpoints users can retrieve data from or perform specific actions in Smartbox from an external source e.g. upload data or get a list of boxes. All of the core Smartbox features can be utilised via the API and, by chaining requests, the full end-to-end information request process can be carried out securely from an external location.
The list of available endpoints can be found below and we will be continually adding to these in the future.
Available Endpoints
| Endpoint | Description |
| Create box | Create a new box |
| Create Dictionary | Create a new dictionary |
| Delete Dictionary | Delete a dictionary |
| Download Audit Copy | Download the audit copy of a document |
| Download Original | Download the original PDF of a document |
| Download Redaction Copy | Download the redacted PDF document |
| Edit Dictionary | Make changes to a dictionary |
| List Box Content | List items within a box |
| List boxes | List existing boxes |
| List Dictionary terms | Returns the list of terms in a dictionary |
| Query Box Status | Check box status |
| Query Dictionaries | List available dictionaries |
| Query Document Status | Get document's redaction and analysis status |
| Query Regular Expressions | List regular expressions |
| Remove box | Delete a box |
| Remove Dictionary terms | Delete specific terms from a Dictionary |
| Remove File | Delete a file |
| Replace Dictionary | Overwrite a Dictionary with a new set of terms |
| Request Hashes Deduplication | List duplicate files |
| Request Hashes Near-Deduplication | List near duplicate files |
| Send files to Smartbox | Upload to a box |
| Trigger Bulk Redaction | Bulk redact a box |
| Trigger De-threading | De-thread a box |
| Trigger Deduplication | Remove duplicates from a box |
| Trigger Near Deduplication | Remove near duplicates from a box |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article