API documentation for Smartbox.ai Endpoints
- Version: 1.0.1
- Authorization: Bearer [accessToken]
Methods
[ Jump to Models ]
Table of Contents
post /box-contentget /box-status-by-upload-idget /box-statusget /boxespost /create-boxpost /create-dictionarypost /delete-boxdelete /delete-dictionarypost /delete-fileget /dictionariesget /dictionary-termsget /document-statusget /download-audit-copyget /download-originalget /download-redacted-copypost /edit-dictionarypost /overwrite-dictionaryget /regular-expressionspost /remove-dictionary-termspost /request-hash-list-deduplicationpost /request-hash-list-near-deduplicationpost /trigger-bulk-redactionpost /trigger-de-threadingpost /trigger-deduplicationpost /trigger-near-deduplicationpost /upload
Up
post /box-contentGet content (boxContentPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body BoxContentRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"documents" : [ {
"path" : "path",
"size" : 0,
"docId" : "docId",
"name" : "name"
}, {
"path" : "path",
"size" : 0,
"docId" : "docId",
"name" : "name"
} ],
"totalDocuments" : 6,
"apiCallMessage" : "apiCallMessage",
"apiCallStatus" : "apiCallStatus"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Document management response BoxContentResponseUp
get /box-status-by-upload-idQuery box status by upload ID (boxStatusByUploadIdGet)
Query parameters
uploadId (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"boxRedacted" : true,
"numberOfFilesProcessed" : 6,
"apiCallMessage" : "apiCallMessage",
"totalFiles" : 0,
"apiCallStatus" : "apiCallStatus",
"extractionInProgress" : true,
"boxAnalysed" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
File processing status response BoxStatusResponseUp
get /box-statusQuery box status (boxStatusGet)
Query parameters
boxId (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"boxRedacted" : true,
"numberOfFilesProcessed" : 6,
"apiCallMessage" : "apiCallMessage",
"totalFiles" : 0,
"apiCallStatus" : "apiCallStatus",
"extractionInProgress" : true,
"boxAnalysed" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
File processing status response BoxStatusResponseUp
get /boxesList boxes (boxesGet)
Query parameters
pageNumber (required)
Query Parameter —
pageRows (required)
Query Parameter —
sort (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"boxList" : [ {
"visibleToDownload" : true,
"boxName" : "boxName",
"sharingAvailability" : true,
"usersBoxVisible" : [ "usersBoxVisible", "usersBoxVisible" ],
"visibleAllUsers" : true,
"boxId" : "boxId",
"usersAccessDownload" : [ "usersAccessDownload", "usersAccessDownload" ]
}, {
"visibleToDownload" : true,
"boxName" : "boxName",
"sharingAvailability" : true,
"usersBoxVisible" : [ "usersBoxVisible", "usersBoxVisible" ],
"visibleAllUsers" : true,
"boxId" : "boxId",
"usersAccessDownload" : [ "usersAccessDownload", "usersAccessDownload" ]
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
A list of boxes BoxListResponseUp
post /create-boxCreate box (createBoxPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body CreateBoxRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"boxName" : "boxName",
"message" : "message",
"boxId" : "boxId",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Box creation response CreateBoxResponseUp
post /create-dictionaryCreate Dictionary (createDictionaryPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body CreateDictionaryRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"dictionaryId" : "dictionaryId",
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary creation response CreateDictionaryResponseUp
post /delete-boxDelete box (deleteBoxPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body DeleteBoxRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Box deletion response DeleteBoxResponseUp
delete /delete-dictionaryDelete Dictionary (deleteDictionaryDelete)
Query parameters
dictionaryName (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary deletion response DeleteDictionaryResponseUp
post /delete-fileDelete File (deleteFilePost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body DeleteFileRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
File deletion response DeleteFileResponseUp
get /dictionariesList Dictionaries (dictionariesGet)
Return type
Example data
Content-Type: application/json
{
"totalDictionaries" : 6,
"dictionaries" : [ {
"dictionaryName" : "dictionaryName",
"dictionaryId" : "dictionaryId",
"termsCount" : 0
}, {
"dictionaryName" : "dictionaryName",
"dictionaryId" : "dictionaryId",
"termsCount" : 0
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary list response DictionaryListResponseUp
get /dictionary-termsList Dictionary Terms (dictionaryTermsGet)
Query parameters
dictionaryName (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"totalTerms" : 0,
"dictionaryName" : "dictionaryName",
"terms" : [ {
"termId" : "termId",
"description" : "description",
"term" : "term"
}, {
"termId" : "termId",
"description" : "description",
"term" : "term"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Terms list response DictionaryTermsResponseUp
get /document-statusQuery document status (documentStatusGet)
Query parameters
docId (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"path" : "path",
"size" : 0,
"name" : "name",
"id" : "id"
},
"apiCallMessage" : "apiCallMessage",
"redactionStatus" : true,
"analysisStatus" : true,
"apiCallStatus" : "apiCallStatus"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Document retrieval response DocumentStatusResponseUp
get /download-audit-copyDownload audit document (downloadAuditCopyGet)
Query parameters
docId (required)
Query Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/octet-stream
Responses
200
File download response byte[]Up
get /download-originalDownload original document (downloadOriginalGet)
Query parameters
docId (required)
Query Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/octet-stream
Responses
200
File download response byte[]Up
get /download-redacted-copyDownload redacted document (downloadRedactedCopyGet)
Query parameters
docId (required)
Query Parameter —
Return type
byte[]
Example data
Content-Type: application/json
""Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/octet-stream
Responses
200
File download response byte[]Up
post /edit-dictionaryEdit Dictionary (editDictionaryPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:multipart/form-data
Form parameters
dictionaryId (required)
Form Parameter —
file (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary edit response EditDictionaryResponseUp
post /overwrite-dictionaryOverwrite Dictionary (overwriteDictionaryPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:multipart/form-data
Form parameters
dictionaryId (required)
Form Parameter —
file (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary overwrite response OverwriteDictionaryResponseUp
get /regular-expressionsList Regular Expressions (regularExpressionsGet)
Return type
Example data
Content-Type: application/json
[ {
"regex" : "regex",
"description" : "description",
"id" : "id",
"title" : "title"
}, {
"regex" : "regex",
"description" : "description",
"id" : "id",
"title" : "title"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Successful response RegularExpressionsResponseUp
post /remove-dictionary-termsRemove Dictionary Terms (removeDictionaryTermsPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:multipart/form-data
Form parameters
dictionaryId (required)
Form Parameter —
file (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dictionary term removal response RemoveDictionaryTermsResponseUp
post /request-hash-list-deduplicationRequest Hash List for Deduplication (requestHashListDeduplicationPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body RequestHashListDeduplicationRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"totalRows" : 6,
"hashList" : [ {
"fileName" : "fileName",
"numberOfDuplicates" : 0,
"hash" : "hash"
}, {
"fileName" : "fileName",
"numberOfDuplicates" : 0,
"hash" : "hash"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Deduplication hash list response RequestHashListDeduplicationResponseUp
post /request-hash-list-near-deduplicationRequest Hash List for Near Deduplication (requestHashListNearDeduplicationPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body RequestHashListNearDeduplicationRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"totalRows" : 0,
"hashList" : [ {
"fileName" : "fileName",
"numberOfDuplicates" : 0,
"hash" : "hash"
}, {
"fileName" : "fileName",
"numberOfDuplicates" : 0,
"hash" : "hash"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Hash list for near deduplication requested RequestHashListNearDeduplicationResponseUp
post /trigger-bulk-redactionTrigger Bulk Redaction (triggerBulkRedactionPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body TriggerBulkRedactionRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "Bulk redaction process was triggered successfully!",
"status" : "Success"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Bulk redaction process response TriggerBulkRedactionResponseUp
post /trigger-de-threadingTrigger De-threading (triggerDeThreadingPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body TriggerDeThreadingRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "Dethreading process was triggered successfully!",
"status" : "Success"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Dethreading process response TriggerDeThreadingResponseUp
post /trigger-deduplicationTrigger Deduplication (triggerDeduplicationPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body TriggerDeduplicationRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "Deduplication process was triggered successfully!",
"status" : "Success"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Deduplication process response TriggerDeduplicationResponseUp
post /trigger-near-deduplicationTrigger Near Deduplication (triggerNearDeduplicationPost)
Consumes
This API call consumes the following media types via the Content-Typerequest header:application/json
Request body
body TriggerNearDeduplicationRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"message" : "Near deduplication process was triggered successfully!",
"status" : "Success"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Near deduplication process response TriggerNearDeduplicationResponseUp
post /uploadUpload file (uploadPost)
Upload files to a box
Consumes
This API call consumes the following media types via the Content-Typerequest header:multipart/form-data
Form parameters
files (required)
Form Parameter — format: binary
boxId (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"uploadId" : "uploadId",
"message" : "message",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.application/json
Responses
200
Upload status response UploadFileResponseModels
[ Jump to Methods ]
Table of Contents
BoxBoxContentRequestBoxContentResponseBoxContentResponse_documentsBoxListResponseBoxStatusResponseCreateBoxRequestCreateBoxResponseCreateDictionaryRequestCreateDictionaryResponseDeleteBoxRequestDeleteBoxResponseDeleteDictionaryResponseDeleteFileRequestDeleteFileResponseDictionaryListResponseDictionaryListResponse_dictionariesDictionaryTermsResponseDictionaryTermsResponse_termsDocumentStatusResponseDocumentStatusResponse_metadataEditDictionaryRequestEditDictionaryResponseOverwriteDictionaryRequestOverwriteDictionaryResponseRegularExpressionsResponseRegularExpressionsResponse_innerRemoveDictionaryTermsRequestRemoveDictionaryTermsResponseRequestHashListDeduplicationRequestRequestHashListDeduplicationResponseRequestHashListDeduplicationResponse_hashListRequestHashListNearDeduplicationRequestRequestHashListNearDeduplicationResponseTriggerBulkRedactionRequestTriggerBulkRedactionRequest_redactionOptionsTriggerBulkRedactionResponseTriggerDeThreadingRequestTriggerDeThreadingResponseTriggerDeduplicationRequestTriggerDeduplicationResponseTriggerNearDeduplicationRequestTriggerNearDeduplicationResponseUploadFileRequestUploadFileResponse
Box Up
boxId (optional)
String A unique identifier for the box
boxName (optional)
String The name of the box
sharingAvailability (optional)
Boolean Indicates if the box is available for sharing
visibleToDownload (optional)
Boolean Indicates if the box is visible for download
visibleAllUsers (optional)
Boolean Indicates if the box is visible to all users
usersAccessDownload (optional)
array[String] A list of users who have access to download the box or null if no specific users are assigned
usersBoxVisible (optional)
array[String] A list of users who can see the box or null if no specific users are assigned
BoxContentResponse Up
documents (optional)
array[BoxContentResponse_documents] List of documents
totalDocuments (optional)
Integer Total number of documents
apiCallMessage (optional)
String Message indicating the result of the API call
apiCallStatus (optional)
String Status of the API call
BoxListResponse Up
boxList (optional)
BoxStatusResponse Up
totalFiles (optional)
Integer Total number of files to be processed
numberOfFilesProcessed (optional)
Integer Number of files that have been processed so far
boxRedacted (optional)
Boolean Indicates if the box has been redacted
extractionInProgress (optional)
Boolean Indicates if the extraction process is currently in progress
boxAnalysed (optional)
Boolean Indicates if the box has been analysed
apiCallMessage (optional)
String Message indicating the result of the API call
apiCallStatus (optional)
String Status of the API call
CreateBoxRequest Up
boxName
boxConfiguration (optional)
String Default or Advanced
example: Advanced
analysisConfiguration (optional)
String Selected PII, Dictionaries and Regex for analysis
example: ["doc_anotate_address_email","doc_anotate_address_url",{"selectedRegexList":"EE"},{"selectedBusinessTerms":4}]
securityConfiguration (optional)
Object Sharing and download access options
example: [{"shareFolder":true},{"visibleAllUsers":true},{"visibleToDownload":true},{"usersBoxVisible":[]},{"usersAccessDownload":[]}]
CreateDictionaryRequest Up
dictionaryName
String Name of the dictionary to be created
terms
array[String] List of terms to be included in the dictionary
DeleteBoxRequest Up
boxId (optional)
DeleteFileRequest Up
fileId (optional)
DictionaryListResponse Up
dictionaries (optional)
array[DictionaryListResponse_dictionaries] List of dictionaries
totalDictionaries (optional)
Integer Total number of dictionaries
DictionaryTermsResponse Up
dictionaryName (optional)
String Name of the dictionary
terms (optional)
array[DictionaryTermsResponse_terms] List of terms in the dictionary
totalTerms (optional)
Integer Total number of terms in the dictionary
DocumentStatusResponse Up
redactionStatus (optional)
Boolean Indicates if the document has been redacted
analysisStatus (optional)
Boolean Indicates if the document has been analysed
metadata (optional)
apiCallMessage (optional)
String Message indicating the result of the API call
apiCallStatus (optional)
String Status of the API call
DocumentStatusResponse_metadata Up
Metadata of the document
RequestHashListDeduplicationResponse Up
hashList (optional)
array[RequestHashListDeduplicationResponse_hashList] List of file hashes and their details
totalRows (optional)
Integer Total number of rows in the hash list
RequestHashListNearDeduplicationResponse Up
hashList (optional)
array[RequestHashListDeduplicationResponse_hashList] List of file hashes and their details
totalRows (optional)
Integer Total number of rows in the hash list
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