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 Fields API

Field catalog management.

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

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

This API exposes 4 operations across 2 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.

4 operations 2 paths 1 schemas 2 GET1 POST1 PUT

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 Fields 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 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Fields 4

Field catalog management.

GET
/fields
List available fields.
getFields → 200
POST
/fields
Create a custom extraction field.
createField body → 201
GET
/fields/{field_id}/metadata
Retrieve field metadata.
getFieldMetadata 1 param → 200
PUT
/fields/{field_id}/metadata
Update field metadata.
updateFieldMetadata 1 param body → 200

Schemas 1

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

Field
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuva-fields-api-openapi.yml Raw ↑

Other APIs Zuva publishes across the network.

Zuva Classification API
Zuva Field Extraction API
Zuva Files API
Zuva OCR API