Skip to content
VerifAIer
Home / Docs / SDK
Walkthrough

SDK

Embed VerifAIer in your services with the one official Python client.

~4 min readDifficulty: MediumPrereq: a running API

What it is

The SDK is one typed Python client, vailidator.sdk.VerifAIerClient, shipped inside the VerifAIer distribution. Its governance accessor covers the twelve open /api/v1 operations and its resolution accessor covers the Resolution Layer.

The OEM SDK Foundation is retired. The standalone packages under sdk/python (verifaier_sdk) and sdk/typescript (@verifaier/sdk) are retired (WP-10I). They still build requests exactly as before, because partners may have vendored them, and they are not where new work goes. There is no current TypeScript client.

Why it exists

So you can embed governance directly in your services in a few lines, without hand-rolling HTTP for twelve endpoints, and without a second engine behind it. The client delegates; it reimplements nothing.

When to use it

Use the SDK when integrating VerifAIer into an application or pipeline, rather than calling the API by hand.

Where it fits / architecture position

The SDK is a typed surface over the same runtime every other surface reads. For the open tier it builds the request; you supply the sender, or you configure one and let the client send it.

Your servicecode
SDKrequest builders
Transportyour HTTP
/api/v1/*VerifAIer

Typical workflow

  • Install VerifAIer; the client ships with it.
  • Construct a client, then give the governance accessor a base URL and a sender.
  • Call the named method for the operation, or prepare() it and dispatch it yourself.

Step-by-step usage

from vailidator.sdk import VerifAIerClient

client = VerifAIerClient.for_user("you")
gov = client.governance.with_base_url("http://localhost:8000").with_sender(send)
answer = gov.assess_trust({"evidence": envelope})
print(answer.payload["trust_level"])
# or build it and dispatch it yourself
call = client.governance.prepare("assessTrust", {"evidence": envelope})
call.method, call.url, call.body

Inputs and outputs

Inputs: the same JSON bodies as the API (e.g. evidence). Outputs: a PreparedCall from prepare(), or a GovernanceAnswer carrying the operation, the status and the payload. The client adds no hidden network and no telemetry.

Real example

One method exists per operation, audit_conversation, assess_compliance, assess_risk, assess_quality, assess_trust, issue_passport, assess_reputation, observe_registry_entry, export_signals, and the registry and control-centre reads. The names are derived from the public contract rather than typed out, so the table cannot drift. See the SDK reference for all twelve.

Expected results

  • With a sender, a GovernanceAnswer mirroring the API.
  • Without one, a PreparedCall you can dispatch yourself.

Common mistakes

  • Expecting a published package. Nothing is on PyPI or npm; the client ships with the distribution.
  • Reaching for verifaier_sdk or @verifaier/sdk. Both are retired, and governance.prepare() is what replaced them.
  • Forgetting to supply a sender. The accessor prepares by design and only sends when you configure one.

Troubleshooting

  • Import error: install the distribution, pip install -e . from a checkout.
  • No response: you prepared a call but configured no sender, dispatch it yourself or pass one to with_sender().

Related documentation

Next: API

Continue the operational walkthroughs.

APISDK reference