GoodMem
ReferenceClient SDKsJava SDK

OCR API

OCR API documentation for Java SDK

The default url is https://localhost:8080

MethodHTTP requestDescription
ocrDocumentPOST /v1/ocr:documentRun 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 classes:
import ai.pairsys.goodmem.client.ApiClient;
import ai.pairsys.goodmem.client.ApiException;
import ai.pairsys.goodmem.client.Configuration;
import ai.pairsys.goodmem.client.auth.*;
import ai.pairsys.goodmem.client.models.*;
import ai.pairsys.goodmem.client.api.OcrApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("[http://localhost:8080](http://localhost:8080)");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    OcrApi apiInstance = new OcrApi(defaultClient);
    OcrDocumentRequest ocrDocumentRequest = new OcrDocumentRequest(); // OcrDocumentRequest | OCR request payload
    try {
      OcrDocumentResponse result = apiInstance.ocrDocument(ocrDocumentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OcrApi#ocrDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
ocrDocumentRequestOcrDocumentRequestOCR request payload

Return type

OcrDocumentResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OCR results by page-
400Invalid request or unsupported input-
401Unauthorized-
403Forbidden-
429Rate limit exceeded-
500Internal server error-