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 Field Extraction API

Extract field values from documents.

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

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

This API exposes 4 operations across 4 paths, and defines 3 schemas. 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.

4 operations 4 paths 3 schemas 3 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 Field Extraction 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 4

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

Field Extraction 4

Extract field values from documents.

POST
/extraction
Create field extraction requests.
createExtraction body → 202
GET
/extractions
Query multiple extraction requests.
getExtractions 1 param → 200
GET
/extraction/{request_id}
Retrieve an extraction request status.
getExtraction 1 param → 200
GET
/extraction/{request_id}/results/text
Retrieve extraction text results.
getExtractionResultsText 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Request (4 properties), ExtractionResults (3 properties), ExtractionRequest (3 properties). Each schema is shown below with its type and property counts.

ExtractionRequest
object
3 properties 2 required
ExtractionResults
object
3 properties
Request
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuva-field-extraction-api-openapi.yml Raw ↑

Other APIs Zuva publishes across the network.

Zuva Classification API
Zuva Fields API
Zuva Files API
Zuva OCR API