OCR API
OCR API documentation for JavaScript SDK
The default url is http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| ocrDocument | POST /v1/ocr:document | Run OCR on a document or image |
ocrDocument
OcrDocumentResponse ocrDocument(ocrDocumentRequest)
Run OCR on a document or image
Runs layout-aware OCR on the provided document bytes and returns per-page results. When a page range is provided, only the inclusive subset is processed. Requires OCR_DOCUMENT permission.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.OCRApi();
let ocrDocumentRequest = {"content":"JVBERi0xLjQKJcTl8uXr...","format":"PDF","includeRawJson":"true","includeMarkdown":"true","startPage":"0","endPage":"4"}; // OcrDocumentRequest | OCR request payload
apiInstance.ocrDocument(ocrDocumentRequest).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ocrDocumentRequest | OcrDocumentRequest | OCR request payload |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json