Schema Diff API

Infers a schema for each of two record sets and reports added fields, removed fields, and per-field type changes — a fast guard against silent upstream schema drift.

What it does

Compare inferred schemas of two record sets.

When to use it

Reach for Schema Diff when you need to answer: How did the shape of my data change between two sources? It sits in the Detect stage of the catalog — surface anomalies and revenue exposure.

Endpoint & cost

POST /api/v1/schema-diff

Cost: Per credit. Zaps draw down your shared monthly allowance; requests that fail validation are not charged.

Authentication

Send your key as a bearer token: Authorization: Bearer zap_live_…. See Authentication for key management and the alternate header.

Example request

curl https://zapinner.com/api/v1/schema-diff \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"source_a":[{"first_name":"Jane","age":30}],"source_b":[{"firstName":"Jane","age":"thirty"}]}'
Every response is structured JSON and includes a request_id. Full field-level request and response schemas for this endpoint live in the OpenAPI spec and the API reference.

Errors & limits

Errors use one consistent shape ( error.code, error.message, request_id). See Errors and Rate limits.

SDK

Schema Diff has typed methods in both the JavaScript and Python SDKs. Both are implemented and package-ready but not yet published to npm / PyPI — until they ship, vendor the package source or install from a git ref, or call the endpoint over HTTPS with the example above.

Try it

Select Schema Diff in the playground to see the request, or run it live with your API key.

  • Anomaly Detection Flag values that look unusual against the rest of the dataset.
  • Revenue Leakage Analyze orders, invoices, and payments for revenue leakage and exposure.
  • Completeness Report per-field fill rate and an overall completeness score.
  • Consistency Report each column's dominant type and how much data agrees.
  • Data Quality A composite 0-100 quality score with an explainable breakdown.
  • Drift Compare a baseline to current data and report per-field drift.
  • Change Detect A keyed diff: added, removed, changed, and unchanged records.
  • Schema Validate Validate records against a declared field schema.
  • Validate Email Syntax + structural email validation with normalization.
  • PII Detect Locate PII without ever echoing the sensitive values.