Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nanonets OCR Retrieve API

Retrieve prediction results for a file, page, or batch.

Nanonets OCR Retrieve API is one of 10 APIs that Nanonets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include OCR Retrieve. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://app.nanonets.com.

3 operations 3 paths 4 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Server
https://app.nanonets.com
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Nanonets OCR Retrieve API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

OCR Retrieve 3

Retrieve prediction results for a file, page, or batch.

GET
/Inferences/Model/{model_id}/InferenceRequest/{request_file_id}
Get Prediction File By File ID
ocrModelGetPredictionFileByFileId 2 params → 200
GET
/Inferences/Model/{model_id}/InferenceRequest/{request_file_id}/page/{page_id}
Get Prediction File By Page ID
ocrModelGetPredictionFileByPageId 3 params → 200
GET
/Inferences/Model/{model_id}/InferenceRequest/
Get All Prediction Files
ocrModelListPredictionFiles 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Prediction (15 properties), TableCell (14 properties), ModeratedPage (6 properties), ModeratedFileResponse (5 properties). Each schema is shown below with its type and property counts.

ModeratedFileResponse
object
5 properties
ModeratedPage
object
6 properties
Prediction
object
15 properties
TableCell
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nanonets-ocr-retrieve-api-openapi.yml Raw ↑

Other APIs Nanonets publishes across the network.

Nanonets External Integrations API
Nanonets File Assignment API
Nanonets File Delete API
Nanonets File Export API
Nanonets File Review API
Nanonets File Update API
Nanonets Image Classification Predict API
Nanonets OCR Predict API
Nanonets OCR Train API