Upload Document With Auto Classification Feature

Endpoint Name: URL/access/klearstack/autoclassify

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The autoclassify endpoint will be used to update enable / disable fields or update the settings of fields.

Method	URL
POST	URL/access/klearstack/autoclassify

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
classification_type	string	Yes	"Page Classification" or "Document Classification" as value
file	binary	Yes	Single image (jpg/jpeg/png) or pdf file.

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/autoclassify" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "classification_type=Replace_classification_type_Here" \
  --form "file=@\"C:/Users/user/Downloads/xyz.pdf\""
  

Python

• Request Body

import requests

url = "URL/access/klearstack/autoclassify"

payload = {'company_name': 'Replace_Company_Name_Here',
'classification_type': 'Replace_classification_type_Here'}
files=[
  ('file',('xyz.pdf',open('C:/Users/user/Downloads/xyz.pdf','rb'),'application/pdf'))
]
headers = {
  'Authorization': 'Bearer your_token_here'
  }

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("company_name","Replace_Company_Name_Here")
  .addFormDataPart("classification_type","Replace_classification_type_Here")
  .addFormDataPart("file","C:/Users/user/Downloads/xyz.pdf",
    RequestBody.create(MediaType.parse("application/octet-stream"),
    new File("C:/Users/user/Downloads/xyz.pdf")))
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/autoclassify")
  .method("POST", body)
  .addHeader("Authorization", "Bearer your_token_here")
  .build();
Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');
let data = new FormData();
data.append('company_name', 'Replace_Company_Name_Here');
data.append('classification_type', 'Replace_classification_type_Here');
data.append('file', fs.createReadStream('C:/Users/user/Downloads/xyz.pdf'));

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/autoclassify',
  headers: { 
    'Authorization': 'Bearer your_token_here', 
    ...data.getHeaders()
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.
var data = new FormData();
data.append("company_name", "Replace_Company_Name_Here");
data.append("classification_type", "Replace_classification_type_Here");
data.append("file", fileInput.files[0], "C:/Users/user/Downloads/xyz.pdf");
 
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/access/klearstack/autoclassify");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(data);

API Response

Status code	Example Response
200	{'status': 'success', 'description': 'File uploaded and classification initiated successfully','OCR_ref_no': batch_id}
400	{'status': 'fail', 'description': 'Missing required fields: {field}'}
500	{'error': error}