Explain API

Turn a score or decision into a structured, human-readable explanation of the factors behind it.

What it does

Get a structured, factor-by-factor explanation of a result.

When to use it

Reach for Explain when you need to answer: “Why did it decide that?” It sits in the Understand stage of the catalog — compare records and explain results.

Endpoint & cost

POST /api/v1/explain

Cost: 1 Zap. 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://api.zapiit.com/v1/explain \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"score":0.94,"factors":[{"name":"email_match","weight":0.6}]}'

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

The TypeScript SDK (@zapiit/sdk) is coming soon. Until it ships, call the endpoint over HTTPS with the example above — the API is plain JSON and needs no dependency.

Try it

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

Match — Decide whether two records refer to the same real-world entity.
Compare — Surface the differences between two records or datasets.