5-Minute Quickstart
Get VeriProof capturing your AI application’s decisions in five minutes. You will install the SDK, configure your API key, make one instrumented call, and verify the trace appears in the Customer Portal.
Before you start: You need a VeriProof API key. Request one from Settings → Security in the Customer Keys panel.
Install the SDK
Python
pip install veriproof-sdkIf your application uses a specific AI framework, install the matching adapter alongside the core SDK:
# LangGraph
pip install veriproof-sdk veriproof-sdk-instrumentation-langgraph
# CrewAI
pip install veriproof-sdk veriproof-sdk-instrumentation-crewai
# OpenAI Agents SDK
pip install veriproof-sdk veriproof-sdk-instrumentation-openai-agents
# LlamaIndex
pip install veriproof-sdk veriproof-sdk-instrumentation-llamaindex
# Pydantic AI
pip install veriproof-sdk veriproof-sdk-instrumentation-pydantic-ai
# Google ADK
pip install veriproof-sdk veriproof-sdk-instrumentation-google-adkSet your API key
Set VERIPROOF_API_KEY as an environment variable. Never hardcode API keys in source files.
bash / macOS / Linux
export VERIPROOF_API_KEY="vp_cust_myapp.abc123.xyz789"In production, load secrets from your platform’s secret store — Azure Key Vault, AWS Secrets Manager, or Kubernetes Secrets — rather than environment variables committed to configuration files.
Initialize VeriProof
Call configure_veriproof (or the equivalent for your language) once at application startup, before any AI calls run.
Python
import os
from veriproof_sdk import VeriproofClientOptions, configure_veriproof
configure_veriproof(
VeriproofClientOptions(
api_key=os.environ["VERIPROOF_API_KEY"],
application_id="my-ai-app", # Must match an Application in the portal
),
service_name="my-ai-app",
set_global=True, # Registers as the global TracerProvider
)After this call, all OpenTelemetry spans from this process are automatically exported to VeriProof — including spans from any framework adapter you installed.
Make your first instrumented call
If you installed a framework adapter, your existing AI code is already instrumented — run it now and skip to step 5.
If you are instrumenting manually, use the session builder:
Python
from veriproof_sdk import (
VeriproofSession, DecisionContext, RiskLevel, SessionOutcome, StepTags
)
async def my_first_session():
session = (
VeriproofSession(application_id="my-ai-app")
.with_session_id("quickstart-001")
.with_intent("quickstart_demo")
)
async with session:
session.add_chat_turn(
prompt="Should we approve this application?",
response="Yes — all criteria met.",
model="gpt-4o",
)
session.set_decision(
DecisionContext.with_options(
"Application review",
options=["approve", "deny"],
selected="approve",
rationale="All eligibility criteria satisfied.",
confidence=0.95,
)
)
session.set_outcome(SessionOutcome.APPROVED, risk_level=RiskLevel.LOW)Verify the trace in the portal
- Open the Customer Portal and navigate to Decisions in the left sidebar.
- Your session should appear within 10–30 seconds of the call completing.
- Click into the session to see the full step timeline, governance attributes, and decision context.
Trace not appearing? The most common causes are an invalid API key, a mismatched Application ID, or a network issue preventing the SDK from reaching the ingest endpoint. See the SDK Troubleshooting Guide for a step-by-step diagnosis.
What just happened?
When your session completed, VeriProof:
- Received the OTel spans from the SDK
- Validated the batch’s Merkle root
- Stored the compliance record in your tenant’s isolated partition
- Evaluated your alert rules against the new session
- Queued the session’s leaf hash for the next blockchain anchoring batch
Within the next anchoring cycle (≤ 30 seconds in production), a proof that this record existed is written to the Solana blockchain. No further action is needed — the anchor is automatic.
Next steps
- First Integration Guide — add governance annotations, configure alert rules, and navigate the portal
- API Keys — key formats, scopes, and rotation
- SDK Reference — Python — full API reference for
veriproof-sdk