DEVELOPER DOCUMENTATION

Build with SOVR

完整的 API 文档、SDK 指南和集成示例,帮助你快速接入 AI 责任层。

Quick Start

5 分钟快速上手 SOVR 责任层。以下示例展示如何安装 SDK 并进行第一次策略评估。

terminal
# 安装 SOVR SDK
npm install @sovr/sdk

# 或使用 Python
pip install sovr-sdk

获取 API 密钥

登录 SOVR Cockpit → Settings → API Keys 创建新的 API 密钥。 密钥格式:sovr_sk_live_xxxxxxxxxxxx

REST API Reference

完整的 REST API 端点列表。所有请求需要在 Header 中携带 Authorization: Bearer YOUR_API_KEY

Base URL: https://api.sovr.ai/v1Version: v1
MethodEndpoint
POST/v1/decision/evaluate
GET/v1/decision/list
POST/v1/policy/create
GET/v1/policy/list
POST/v1/policy/publish
POST/v1/approval/approve
POST/v1/approval/deny
GET/v1/audit/logs
POST/v1/trustBundle/create
POST/v1/trustBundle/evaluate
GET/v1/valueFunction/weights
POST/v1/alert/trigger

Webhooks

配置 Webhook 接收实时事件通知。所有 Webhook 请求都会携带签名,确保请求来源可信。

支持的事件类型

decision.approved决策通过审批
decision.denied决策被拒绝
decision.pending决策等待审批
approval.pending新的审批请求
approval.completed审批完成
policy.published策略发布
policy.updated策略更新
alert.triggered告警触发
budget.exceeded预算超限
killswitch.activatedKill Switch 激活

Webhook 处理示例

webhook.js
// Webhook 事件处理
app.post('/webhooks/sovr', async (req, res) => {
  const signature = req.headers['x-sovr-signature'];
  
  // 验证签名
  const isValid = sovr.webhooks.verify(
    req.body,
    signature,
    process.env.SOVR_WEBHOOK_SECRET
  );
  
  if (!isValid) {
    return res.status(401).json({ error: 'Invalid signature' });
  }
  
  const event = req.body;
  
  switch (event.type) {
    case 'decision.approved':
      console.log('Decision approved:', event.data.decisionId);
      break;
    case 'decision.denied':
      console.log('Decision denied:', event.data.decisionId);
      break;
    case 'approval.pending':
      console.log('Approval required:', event.data.approvalId);
      // 发送通知给审批人
      break;
    case 'alert.triggered':
      console.log('Alert triggered:', event.data.alertType);
      break;
  }
  
  res.json({ received: true });
});

Trust Bundles

信任包是 SOVR 的合规证据打包机制,用于审计追溯和合规报告生成。

trust-bundle.js
// 创建信任包(用于合规审计)
const bundle = await sovr.trustBundle.create({
  name: 'Q1 2026 Compliance Bundle',
  bundleType: 'compliance',
  entityType: 'quarterly_audit',
  entityId: 'q1_2026',
  description: 'Quarterly compliance evidence package'
});

// 添加证据
await sovr.trustBundle.addEvidence(bundle.id, {
  evidenceType: 'audit_trail',
  evidenceRef: 'audit_log_123',
  evidenceData: {
    period: '2026-Q1',
    totalDecisions: 15000,
    approvalRate: 0.95
  }
});

// 评估充分性
const evaluation = await sovr.trustBundle.evaluate(bundle.id);
// 返回: { sufficiencyScore: 85, status: 'sufficient', missingEvidence: [] }
证据类型
• decision_log - 决策日志
• audit_trail - 审计轨迹
• policy_snapshot - 策略快照
• approval_record - 审批记录
• value_score - 价值评分
充分性等级
• insufficient (<40%)
• partial (40-70%)
• sufficient (70-90%)
• verified (>90%)
包类型
• decision - 单决策证据
• policy - 策略变更证据
• audit - 审计周期证据
• compliance - 合规报告证据

Rate Limits & Quotas

API 调用配额根据订阅计划有所不同。超过配额时会返回 429 状态码。

Starter
适合个人开发者
评估请求1,000/月
策略数量5
审计日志保留7 天
Professional
适合成长型团队
评估请求50,000/月
策略数量50
审计日志保留90 天
Enterprise
适合大型企业
评估请求无限制
策略数量无限制
审计日志保留365 天

需要帮助?

查看我们的 GitHub 仓库获取更多示例,或联系技术支持团队。