Documentation
Guides for every OpenVals module, API surface, and security control — searchable and organized by where you are in the platform.
First gate in four steps
- 1Sign up — your workspace and Admin role are created automatically
- 2Connect a model provider or add a model manually
- 3Trigger a validation run from the model's page
- 4Review the gate decision and export the evidence pack
# Authenticate
curl -X POST $API/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "you@company.com", "password": "••••••"}'
# Trigger a validation gate
curl -X POST $API/api/v1/validation/run \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{"modelId": 1, "suiteIds": [1]}'Getting started
Workspace modules
Command Center
Fleet status, control priorities, and drift observability.
Use Case Advisor
Describe a business problem; get ranked model-fit recommendations.
Model Compare
Benchmark candidates on quality, cost, latency, and risk side by side.
Validation Runs
Gate suites: adversarial probes, grounding, PII, bias drift, latency SLOs.
Integrations
Connect OpenAI, Anthropic, Bedrock, Vertex AI, and data sources.
Compliance & Risk
EU AI Act and NIST AI RMF posture, controls, and evidence export.
Security & governance
API reference
Auth Endpoints
POST /auth/signup, /auth/login, /auth/refresh, GET /auth/me.
Models API
Portfolio CRUD, compare, and the public registry projection.
Validation API
Trigger runs, stream progress, fetch decisions and evidence.
Response Envelope & Errors
The { data, meta, error } envelope and error codes every endpoint returns.