API overview

Posted about 1 month ago by Harrison Gowers

TABLE OF CONTENTS

What is an API?
Smartbox.ai API
How does it work?
Available Endpoints

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
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
List Box Content	List items within a box
List boxes	List existing boxes
Query Box Status	Check box status
Query Dictionaries	List dictionaries
Query Document Status	Get document's redaction and analysis status
Query Regular Expressions	List regular expressions
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

Next >>> Access Tokens