Prediction for image file

Nanonets API to upload files to your OCR model in sync mode and to make predictions based on the uploaded images or documents using the file path hosted locally on your system. You can specify multiple file path, this endpoint is optimized for files containing 3 pages or fewer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier for the model to be used for prediction or to fetch predictions.

Query Params
string

Represents the most common ISO language codes. Not specifying a language generally yields the best results.

Body Params
file
required

Path of the file stored locally on your system.

string

Base64 encoded version of the file urls, which can be sourced locally or from publicly available URLs.

string

metadata to save with the document

string

Comma-separated page numbers specifying which pages in the document need processing, e.g., '1,2'.

Responses

400

File missing. Check if you have included a file in the request

OR

Incorrect image. Check if file you included is a valid PNG or JPEG

402

Exhausted Free API Calls. You have exhausted your free API calls please change your plan here

404

Model does not exists. Check if the model id exists

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json