Documentation
Rends documentation: SDKs, approval holds and emergency stop
A complete reference for the four-engine architecture (Discover, Translate, Govern, Comply), the enterprise features, SDKs, and the regulatory coverage that backs the platform. Base URL https://rends.ai/api/v1.
01
Getting started
Every request targets the gateway base URL https://rends.ai/api/v1. Authenticate with either a session JWT (dashboard flows) or an API key issued from Settings → API Keys. All API keys begin with ac_live_.
Quick start: your first check-action call
The fastest path from zero to a live compliance decision is a single POST to the Comply engine.
cURL — first check-action
curl -sS -X POST "https://rends.ai/api/v1/compliance/check-action" \
-H "Authorization: Bearer ac_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"orgId": "org_123",
"agentId": "agent_456",
"actionType": "tool_call",
"actionName": "send_email",
"resourceType": "external_api",
"input_summary": "Drafting outbound message to customer"
}'The response includes a decision (allow, warn, or block), the triggered rules, and a request ID you can match against the audit trail.
Authentication
- API keys —
Authorization: Bearer ac_live_…. Used for engine routes (agents, governance, compliance). Cannot call gateway-owned routes such as/v1/billingor/v1/api-keys. - Session JWT —
Authorization: Bearer <session_jwt>. Issued by our self-hosted identity service and used by the dashboard; the gateway requires organization context.
Base URL & versioning
All public routes are versioned under /v1. This page documents the API surface; the machine-readable OpenAPI 3.1 spec is not currently published to a public URL. Ask us if you need the spec file.
02
Platform overview
Four-engine architecture
Discover
Shadow AI inventory
8 scan types (packages, lockfiles, source, DNS, cloud audit, env, HTTP egress, processes), 25 AI provider signatures, 4 confidence levels. Public Scanner Lite — no SDK required.
Translate
Regulation → policy
7 control templates, custom regulations support, about 1¢ per draft on Haiku. Approved drafts deploy as govern.access_policies rows automatically via the deploy bridge.
Govern
Runtime enforcement
Access policies, prompt-injection detection, conditional access, retention, kill switch, HITL, distributed enforcement mesh with pub/sub reload.
Comply
Evidence + audit
51 regulations tracked, hash-chained audit trails (SHA-512), AICAP™ passports.
Tier overview
| Tier | Price | Highlights |
|---|---|---|
| Starter | $1,500/mo | Usage events, agent lifecycle, four-engine core, public Scanner Lite. |
| Professional | $7,500/mo | + prompt-injection, content safety, bias, drift, scorecards, artifacts. |
| Enterprise | $25,000+/mo | + conditional access, retention, dependency mapping. |
All plans include a 14-day trial; onboarding is by request.
03
Deploy service (internal)
Deploy is platform plumbing — the internal service (port 4001) that handles agent registration, lifecycle transitions, and the dependency graph used by blast-radius analysis. Customer-facing positioning is the four engines above; Deploy is the substrate they all share.
Agents
/v1/agents/v1/agents/v1/agents/:idLifecycle (F10)
Agents move through five stages: planned → active → deprecated → retired → archived. Every transition is recorded as an event.
/v1/agents/:id/lifecycle/v1/agents/:id/lifecycleBody — POST /v1/agents/:id/lifecycle
{
"to_stage": "deprecated",
"reason": "Superseded by v2 retrieval agent",
"successor_agent_id": "agent_abc123",
"metadata": { "ticket": "GOV-481" }
}Dependencies (F11, T2)
Declare upstream/downstream dependencies between agents and the systems they touch, then query the impact graph.
/v1/agents/:id/dependencies/v1/agents/:id/dependencies/v1/agents/:id/dependencies/impact/v1/dependencies/:id/v1/dependencies/:id04
Govern engine
The Govern engine (port 4002) enforces runtime policy: prompt-injection detection, conditional access, retention, the kill switch, HITL approvals, and anomaly detection.
Prompt injection pre-check (F7)
A 16-pattern detector with compound-boost scoring runs before any tool call. Severities arenone, low, medium, high, and critical. When the prompt_injection_detection flag is enabled, requests at high orcritical are blocked.
/v1/govern/check-actionExample response
{
"decision": "block",
"severity": "high",
"score": 0.87,
"patterns_matched": ["override_instructions", "exfiltrate_secrets"],
"compound_boost": 0.15,
"request_id": "req_01HW…"
}Conditional access (F8, T2)
Build context-aware allow/deny policies (IP ranges, time windows, principal claims, resource tags) and evaluate them per call.
/v1/access-policies/v1/access-policies/v1/access-policies/evaluate/v1/access-decisionsRetention policies (F9, T2)
Define data-retention rules per resource type, then trigger immediate enforcement or rely on the scheduled run.
/v1/retention/policies/v1/retention/policies/v1/retention/policies/:id/run/v1/retention/executionsKill switch, HITL, anomalies
The kill switch is available on every tier. Human-in-the-loop approvals and anomaly detection are Professional and Enterprise capabilities. See the dedicated guides for kill switch, HITL, and anomaly detection.
05
Comply engine
The Comply engine (port 4003) is the synchronous compliance gate plus the async evaluation pipeline. The check-action endpoint runs the full pipeline: F7 injection scan → F4 content safety → rules engine → F1 usage events.
Real-time and on-demand evaluation
/v1/compliance/check-action/v1/compliance/evaluateBody — POST /v1/compliance/check-action
{
"orgId": "org_123",
"agentId": "agent_456",
"actionType": "tool_call",
"actionName": "send_email",
"resourceType": "external_api",
"input_summary": "Outbound message to customer about refund"
}Content safety (F4, T1+)
Per-call scan across toxicity, hate, harassment,self_harm, sexual, violence, profanity, andpii. Industry-gated detectors add PHI patterns for healthcare and PCI for financial. Detected PII is auto-redacted in content_preview before persistence.
Bias detection (F2, T1+)
v1 covers three dimensions — gender, race, and age — using keyword/lexicon analysis on agent outputs. Runs post-evaluation on a BullMQ worker so the synchronous path stays fast.
Drift monitoring (F3, T1+)
Z-score detection over daily baselines on latency, error_rate, andcompliance_score. Severities map to standard deviations:
- < 1σ —
info - 1–2σ —
warn - 2–3σ —
critical - > 3σ —
emergency
Risk scorecards (F5, T1+)
Six dimensions roll up to a single grade: compliance, bias, drift,safety, prompt_injection, governance. Aggregated weekly via a BullMQ cron, with a SHA-512 verification hash for tamper evidence.
| Grade | Score band |
|---|---|
| A+ | ≥ 95 |
| A | ≥ 85 |
| B | ≥ 70 |
| C | ≥ 55 |
| D | ≥ 40 |
| F | < 40 |
Compliance artifacts (F6, T1+)
Generate audit-ready Markdown documents on demand — system cards, model cards, DPAs, privacy policies, safety cases, and transparency reports. Each artifact ships with a SHA-512 verification hash.
/v1/compliance/artifacts/generate/v1/compliance/artifacts/v1/compliance/artifacts/:idSupported types: system_card, model_card, dpa, privacy_policy, safety_case, transparency_report.
Usage analytics (F1, T0+)
Every meaningful action is recorded as a usage event, on every tier — including Starter.
compliance_check— every real-time check-action callcompliance_violation— rule failurescompliance_block— blocked outcomesprompt_injection— F7 detectionscontent_safety— F4 scansbias_detection— F2 resultsdrift_detection— F3 alertsrisk_scorecard— F5 weekly aggregatesagent_lifecycle— F10 transitionscompliance_artifact— F6 generations
Discover engine
Discover finds AI usage you didn't know about — through eight scan types covering packages, lockfiles, source code, DNS resolution, cloud audit trails, environment variables, HTTP egress and running processes. 25 AI provider signatures across vendors and SDKs; four confidence levels keep the noise down.
Public AI Exposure Scanner
The same detection logic backs the public, no-account-required scanner at /scanner. Submit a free-text description of your AI usage and get a structured exposure summary in under 10 seconds. Per-IP rate-limited and under a global daily LLM budget cap.
/v1/public/scannerAuthenticated discovery
For org-scoped scans across all eight detection channels, see the discovery routes:
/v1/shadow-scans/v1/shadow-scans/v1/shadow-scans/github-webhookTranslate engine
Translate converts regulations into structured policy drafts you can review, approve, and deploy. Each draft is generated from a regulation (Radar-discovered or org-custom) plus the org context, and emits a JSON artifact whose controls_to_apply array references the platform's seven control templates: human_oversight_gate, audit_log_required, data_classification_filter, model_allowlist, rate_limit_cap, output_content_policy, explainability_mandate. Cost runs about 1¢ per draft on Haiku.
Drafts CRUD + lifecycle
/v1/drafts/v1/drafts/:id/v1/drafts/:id/submit/v1/drafts/:id/approve/v1/drafts/:id/reject/v1/drafts/:id/shadow/v1/drafts/:id/shadow-report/v1/drafts/:id/deploy/v1/drafts/:id/supersedeCustom regulations
Author org-private regulations alongside the public ones — internal AI policies, contractual requirements, board mandates. Create + content-changing updates auto-enqueue a translation job through the same pipeline as Radar-sourced regulations.
/v1/custom-regulations/v1/custom-regulations/v1/custom-regulations/:id/v1/custom-regulations/:id/v1/custom-regulations/:idDeploy bridge — drafts to runtime controls
The deploy bridge is the link between Translate and Govern. When a draft transitions shadow → deployed, the bridge maps each control onto a row in govern.access_policies in a single transaction across schemas. Two of the seven templates (human_oversight_gate and explainability_mandate) map cleanly onto the strict access-policy conditions schema; the other five emit enabled = false stub rows for traceability so the deploy stays fully auditable and re-enable-able once richer enforcement engines (RPL, classification scanner, rate-limit table) land.
After commit, the bridge publishes on the Redis pub/sub channel govern:policies:invalidate. Every Govern instance subscribes and calls EnforcementMesh.notifyPolicyChange() so its in-process policy snapshot reloads atomically — no restart required. Supersede flips enabled = false across the rows by source_draft_id and publishes the same signal.
06
Feature flag gating
Every enterprise feature is gated by a flag and a tier. The gateway checks flags on every request; routes return 403 with AC-1004 when a flag is off for the calling org.
| Feature | Flag key | Starter | Pro | Enterprise |
|---|---|---|---|---|
| Usage AnalyticsUsage data is captured today; customer-facing reporting is not yet available. | usage_analytics | |||
| Agent Lifecycle | agent_retirement | |||
| Prompt Injection | prompt_injection_detection | |||
| Content Safety | content_safety | |||
| Bias Detection | bias_detection | |||
| Drift Monitoring | drift_monitoring | |||
| Risk Scorecards | risk_scorecards | |||
| Compliance Artifacts | compliance_artifacts | |||
| Conditional Access | conditional_access | |||
| Retention Policies | retention_policies | |||
| Dependency Mapping | dependency_mapping |
07
SDKs
Both SDKs wrap the same gateway base URL and share the same auth model. Source for both is generated from the OpenAPI spec.
Framework adapters
9 agent frameworks across the two published SDKs (2.0.0): Node — LangChain, OpenAI Agents and Google ADK; Python — LangChain, LangGraph, CrewAI, AutoGen, OpenAI Agents, Google ADK, Haystack, LlamaIndex and PydanticAI. Both SDKs also ship an OpenTelemetry adapter. Each adapter forwards chain_id, metadata.task_id, and per-call risk hints to the gateway automatically.
08
Regulatory coverage
The compliance catalog ships with 51 regulations across 20 jurisdictions. Rules are mapped to controls and to AICAP document types, so generating an artifact pulls in the right evidence automatically.
US Federal
NIST AI RMF · EO 14110 · FTC Act · ECOA · FCRA · HIPAA · GLBA · SOX · BSA/AML
US State
CCPA / CPRA · NY DFS 500 · Colorado AI Act · Illinois BIPA
EU & UK
EU AI Act · GDPR · UK AI Framework
International
Singapore FEAT · ISO 42001 · OECD AI Principles
09
AICAP framework
The AI Compliance Autonomous Platform (AICAP™) is the framework behind Rends' evidence. Its catalog maps 50 document types to the regulations that call for them, and each AICAP™ passport carries one of four levels, set from the agent's latest evaluation. A passport is a signed record you can share; anyone can look it up at rends.ai/verify.
Bronze
Foundational
Silver
Operational
Gold
Mature
Platinum
Leading
10
Interactive OpenAPI
Every endpoint above is documented with request/response schemas, examples, and AC-XXXX error codes. An interactive reference is not available on this page — the machine-readable spec is not published to a public URL. Ask us if you need it.