Retry Failed Documents

Endpoint Name: retry_failed_documents

Request type : POST

Authorization : None

Endpoint Details: The retry_failed_documents endpoint will be used to get the access token and the refresh token, The validity of the access token will be some minutes, and the refresh token will be days.

Method	URL
POST	URL/access/klearstack/retry_failed_documents

Request Body

Parameters	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in.
batch_id	string	Yes	Batch id received from upload API

Request Code Samples

Shell

• Request Body

curl --location "URL/access/klearstack/retry_failed_documents" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "batch_id=Replace_batch_id_Here"

Python

• Request Body

import requests

url = "URL/access/klearstack/retry_failed_documents"

payload = {'company_name': 'Replace_Company_Name_Here',
'batch_id': 'Replace_batch_id_Here'}
files=[

]
headers = {}

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("batch_id","Replace_batch_id_Here")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/retry_failed_documents")
  .method("POST", body)
  .build();
Response response = client.newCall(request).execute();

Nodejs (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');
let data = new FormData();
data.append('company_name', 'Replace_Company_Name_Here');
data.append('batch_id', 'Replace_batch_id_Here');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/retry_failed_documents',
  headers: { 
    ...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("batch_id", "Replace_batch_id_Here");

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/retry_failed_documents");

xhr.send(data);

API Response

Status code	Example Response
200	{"success": True, "message": "Retry initiated successfully"}
500	{"success": False, "message": "Failed to initiate retry", "details": 'details'}
400	{"success": False, "message": "No batch found with the provided batch_id"}
400	{"success": False, "message": "Batch status is not 'failed'. Only failed batches can be retried."}