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

Zuva OCR API

Optical character recognition.

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

Tagged areas include OCR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://{region}.app.zuva.ai/api/v2.

7 operations 7 paths 1 schemas 6 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://us.app.zuva.ai/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zuva OCR API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Zuva API token passed in the Authorization header as Authorization: Bearer .

Paths & Operations 7

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

OCR 7

Optical character recognition.

POST
/ocr
Create an OCR request.
createOcr body → 202
GET
/ocrs
Query multiple OCR requests.
getOcrs 1 param → 200
GET
/ocr/{request_id}
Retrieve an OCR request status.
getOcr 1 param → 200
GET
/ocr/{request_id}/text
Retrieve OCR extracted text.
getOcrText 1 param → 200
GET
/ocr/{request_id}/images
Download all page images as a zip.
getOcrImages 1 param → 200
GET
/ocr/{request_id}/images/{page_number}
Download a single page image.
getOcrImagePage 2 params → 200
GET
/ocr/{request_id}/layouts
Retrieve layout protobuf binary.
getOcrLayouts 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is OcrResult (7 properties). Each schema is shown below with its type and property counts.

OcrResult
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuva-ocr-api-openapi.yml Raw ↑

Other APIs Zuva publishes across the network.

Zuva Classification API
Zuva Field Extraction API
Zuva Fields API
Zuva Files API