Get Image of Document

Endpoint Name: getimage

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The getimage endpoint will be used to get image of document.

Method	URL
POST	URL/access/klearstack/getimage

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
collection_name	string	Yes	Name of collection of document
id	string	Yes	ID received from key “image_id” of response from api getdocument
ui_image_path	string	Yes	ID received from key “ui_image_list” of response from api getdocument

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/getimage" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "collection_name=Replace_Collection_Name_Here" \
  --form "id=Replace_Image_ID_Here" \
  --form "ui_image_path=Replace_UI_Image_Path_Here"

Python

• Request Body

import requests

url = "URL/access/klearstack/getimage"

payload = {'company_name': 'Replace_Company_Name_Here',
'collection_name': 'Replace_Collection_Name_Here',
'id': 'Replace_Image_ID_Here',
'ui_image_path': 'Replace_UI_Image_Path_Here'}
files=[

]
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_Your_Company_Name_Here")
  .addFormDataPart("collection_name", "Replace_Your_Collection_Name_Here")
  .addFormDataPart("id", "Replace_Your_Image_ID_Here")
  .addFormDataPart("ui_image_path", "Replace_Your_UI_Image_Path_Here")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/getimage")
  .method("POST", body)
  .addHeader("Authorization", "Bearer Replace_Your_Token_Here")
  .build();
Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');

let formData = new FormData();
formData.append('company_name', 'Replace_Your_Company_Name_Here');
formData.append('collection_name', 'Replace_Your_Collection_Name_Here');
formData.append('id', 'Replace_Your_Image_ID_Here');
formData.append('ui_image_path', 'Replace_Your_UI_Image_Path_Here');

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

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 formData = new FormData();
formData.append("company_name", "Replace_Your_Company_Name_Here");
formData.append("collection_name", "Replace_Your_Collection_Name_Here");
formData.append("id", "Replace_Your_Image_ID_Here");
formData.append("ui_image_path", "Replace_Your_UI_Image_Path_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/getimage");
xhr.setRequestHeader("Authorization", "Bearer Replace_Your_Token_Here");

xhr.send(formData);

API Response

Status code	Example Response
200	Binary Image string