API 参考

🌐 其他语言

English 中文简体 Español Português 日本語 Deutsch

本文档为 Symbiont 运行时 API 提供全面的文档。Symbiont 项目提供两个针对不同用例和开发阶段设计的独立 API 系统。

概述

Symbiont 提供两个 API 接口：

  1. 工具审查 API（生产环境） - 一个全面的、生产就绪的 AI 驱动工具审查和签名工作流 API
  2. 运行时 HTTP API（开发预览） - 一个用于直接运行时交互的演进中 API（目前不完整）

工具审查 API（生产环境）

工具审查 API 提供了一个完整的工作流，用于安全地审查、分析和签名 MCP（模型上下文协议）工具，使用 AI 驱动的安全分析和人工监督功能。

基础 URL 

https://your-symbiont-instance.com/api/v1

身份验证

所有端点都需要 Bearer JWT 身份验证：

Authorization: Bearer <your-jwt-token>

核心工作流

工具审查 API 遵循以下请求/响应流程：

graph TD
    A[提交工具] --> B[安全分析]
    B --> C{风险评估}
    C -->|低风险| D[自动批准]
    C -->|高风险| E[人工审查队列]
    E --> F[人工决策]
    F --> D
    D --> G[代码签名]
    G --> H[已签名工具就绪]

端点

审查会话

提交工具进行审查 
POST /sessions

提交 MCP 工具进行安全审查和分析。

请求体：

{
  "tool_name": "string",
  "tool_version": "string",
  "source_code": "string",
  "metadata": {
    "description": "string",
    "author": "string",
    "permissions": ["array", "of", "permissions"]
  }
}

响应：

{
  "review_id": "uuid",
  "status": "submitted",
  "created_at": "2024-01-15T10:30:00Z"
}
列出审查会话 
GET /sessions

检索带有可选过滤的分页审查会话列表。

查询参数：

  • page (integer): 分页的页码
  • limit (integer): 每页项目数
  • status (string): 按审查状态过滤
  • author (string): 按工具作者过滤

响应：

{
  "sessions": [
    {
      "review_id": "uuid",
      "tool_name": "string",
      "status": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T11:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "has_next": true
  }
}
获取审查会话详情 
GET /sessions/{reviewId}

检索特定审查会话的详细信息。

响应：

{
  "review_id": "uuid",
  "tool_name": "string",
  "tool_version": "string",
  "status": "string",
  "analysis_results": {
    "risk_score": 85,
    "findings": ["array", "of", "security", "findings"],
    "recommendations": ["array", "of", "recommendations"]
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}

安全分析

获取分析结果 
GET /analysis/{analysisId}

检索特定分析的详细安全分析结果。

响应：

{
  "analysis_id": "uuid",
  "review_id": "uuid",
  "risk_score": 85,
  "analysis_type": "automated",
  "findings": [
    {
      "severity": "high",
      "category": "code_injection",
      "description": "Potential code injection vulnerability detected",
      "location": "line 42",
      "recommendation": "Sanitize user input before execution"
    }
  ],
  "rag_insights": [
    {
      "knowledge_source": "security_kb",
      "relevance_score": 0.95,
      "insight": "Similar patterns found in known vulnerabilities"
    }
  ],
  "completed_at": "2024-01-15T10:45:00Z"
}

人工审查工作流

获取审查队列 
GET /review/queue

检索等待人工审查的项目，通常是需要手动检查的高风险工具。

响应：

{
  "pending_reviews": [
    {
      "review_id": "uuid",
      "tool_name": "string",
      "risk_score": 92,
      "priority": "high",
      "assigned_to": "reviewer@example.com",
      "escalated_at": "2024-01-15T11:00:00Z"
    }
  ],
  "queue_stats": {
    "total_pending": 5,
    "high_priority": 2,
    "average_wait_time": "2h 30m"
  }
}
提交审查决策 
POST /review/{reviewId}/decision

提交人工审查员对工具审查的决策。

请求体：

{
  "decision": "approve|reject|request_changes",
  "comments": "Detailed review comments",
  "conditions": ["array", "of", "approval", "conditions"],
  "reviewer_id": "reviewer@example.com"
}

响应：

{
  "review_id": "uuid",
  "decision": "approve",
  "processed_at": "2024-01-15T12:00:00Z",
  "next_status": "approved_for_signing"
}

工具签名

获取签名状态 
GET /signing/{reviewId}

检索已审查工具的签名状态和签名信息。

响应：

{
  "review_id": "uuid",
  "signing_status": "completed",
  "signature_info": {
    "algorithm": "RSA-SHA256",
    "key_id": "signing-key-001",
    "signature": "base64-encoded-signature",
    "signed_at": "2024-01-15T12:30:00Z"
  },
  "certificate_chain": ["array", "of", "certificates"]
}
下载已签名工具 
GET /signing/{reviewId}/download

下载带有嵌入签名和验证元数据的已签名工具包。

响应： 已签名工具包的二进制下载。

统计与监控

获取工作流统计 
GET /stats

检索关于审查工作流的全面统计和指标。

响应：

{
  "workflow_stats": {
    "total_reviews": 1250,
    "approved": 1100,
    "rejected": 125,
    "pending": 25
  },
  "performance_metrics": {
    "average_review_time": "45m",
    "auto_approval_rate": 0.78,
    "human_review_rate": 0.22
  },
  "security_insights": {
    "common_vulnerabilities": ["sql_injection", "xss", "code_injection"],
    "risk_score_distribution": {
      "low": 45,
      "medium": 35,
      "high": 20
    }
  }
}

速率限制

工具审查 API 对每种端点类型实施速率限制：

  • 提交端点：每分钟 10 个请求
  • 查询端点：每分钟 100 个请求
  • 下载端点：每分钟 20 个请求

所有响应中都包含速率限制头：

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642248000

错误处理

API 使用标准 HTTP 状态码并返回详细的错误信息：

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Tool source code is required",
    "details": {
      "field": "source_code",
      "reason": "missing_required_field"
    }
  }
}

运行时 HTTP API

运行时 HTTP API 提供对 Symbiont 运行时的直接访问，用于工作流执行、代理管理和系统监控。当启用 http-api 功能时，所有文档化的端点都已完全实现并可用。

基础 URL 

http://127.0.0.1:8080/api/v1

身份验证

代理管理端点需要 Bearer 令牌认证。请设置环境变量 API_AUTH_TOKEN，并在 Authorization 头中包含令牌：

Authorization: Bearer <your-token>

受保护端点：

  • 所有 /api/v1/agents/* 端点都需要认证
  • /api/v1/health、/api/v1/workflows/execute 和 /api/v1/metrics 不需要认证

可用端点

健康检查 

GET /api/v1/health

返回当前系统健康状态和基本运行时信息。

响应（200 OK）：

{
  "status": "healthy",
  "uptime_seconds": 3600,
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "0.1.0"
}

响应（500 内部服务器错误）：

{
  "status": "unhealthy",
  "error": "Database connection failed",
  "timestamp": "2024-01-15T10:30:00Z"
}

可用端点

工作流执行 

POST /api/v1/workflows/execute

使用指定参数执行工作流。

请求体：

{
  "workflow_id": "string",
  "parameters": {},
  "agent_id": "optional-agent-id"
}

响应（200 OK）：

{
  "result": "workflow execution result"
}

代理管理

列出代理 
GET /api/v1/agents

检索运行时中所有活动代理的列表。

响应（200 OK）：

[
  "agent-id-1",
  "agent-id-2",
  "agent-id-3"
]
获取代理状态 
GET /api/v1/agents/{id}/status
Authorization: Bearer <your-token>

获取特定代理的详细状态信息。

响应（200 OK）：

{
  "agent_id": "uuid",
  "state": "active|idle|busy|error",
  "last_activity": "2024-01-15T10:30:00Z",
  "resource_usage": {
    "memory_bytes": 268435456,
    "cpu_percent": 15.5,
    "active_tasks": 3
  }
}
创建代理 
POST /api/v1/agents
Authorization: Bearer <your-token>

使用提供的配置创建新代理。

请求体：

{
  "name": "my-agent",
  "dsl": "DSL 格式的代理定义"
}

响应（200 OK）：

{
  "id": "uuid",
  "status": "created"
}
更新代理 
PUT /api/v1/agents/{id}
Authorization: Bearer <your-token>

更新现有代理的配置。至少需要提供一个字段。

请求体：

{
  "name": "新代理名称",
  "dsl": "更新后的 DSL 格式代理定义"
}

响应（200 OK）：

{
  "id": "uuid",
  "status": "updated"
}
删除代理 
DELETE /api/v1/agents/{id}
Authorization: Bearer <your-token>

从运行时中删除现有代理。

响应（200 OK）：

{
  "id": "uuid",
  "status": "deleted"
}
执行代理 
POST /api/v1/agents/{id}/execute
Authorization: Bearer <your-token>

启动特定代理的执行。

请求体：

{}

响应（200 OK）：

{
  "execution_id": "uuid",
  "status": "execution_started"
}
获取代理执行历史 
GET /api/v1/agents/{id}/history
Authorization: Bearer <your-token>

获取特定代理的执行历史。

响应（200 OK）：

{
  "history": [
    {
      "execution_id": "uuid",
      "status": "completed",
      "timestamp": "2024-01-15T10:30:00Z"
    }
  ]
}

系统指标 

GET /api/v1/metrics

检索全面的系统性能指标。

响应（200 OK）：

{
  "system": {
    "uptime_seconds": 3600,
    "memory_usage": "75%",
    "cpu_usage": "45%"
  },
  "agents": {
    "total": 5,
    "active": 3,
    "idle": 2
  }
}

服务器配置

运行时 HTTP API 服务器可以使用以下选项进行配置：

  • 默认绑定地址：127.0.0.1:8080
  • CORS 支持：可为开发配置
  • 请求跟踪：通过 Tower 中间件启用
  • 功能门控：在 http-api Cargo 功能后可用

数据结构

核心类型 

// 工作流执行请求
WorkflowExecutionRequest {
    workflow_id: String,
    parameters: serde_json::Value,
    agent_id: Option<AgentId>
}

// 代理状态响应
AgentStatusResponse {
    agent_id: AgentId,
    state: AgentState,
    last_activity: DateTime<Utc>,
    resource_usage: ResourceUsage
}

// 健康检查响应
HealthResponse {
    status: String,
    uptime_seconds: u64,
    timestamp: DateTime<Utc>,
    version: String
}

// 创建代理请求
CreateAgentRequest {
    name: String,
    dsl: String
}

// 创建代理响应
CreateAgentResponse {
    id: AgentId,
    status: String
}

// 更新代理请求
UpdateAgentRequest {
    name: Option<String>,
    dsl: Option<String>
}

// 更新代理响应
UpdateAgentResponse {
    id: AgentId,
    status: String
}

// 删除代理响应
DeleteAgentResponse {
    id: AgentId,
    status: String
}

// 执行代理请求
ExecuteAgentRequest {}

// 执行代理响应
ExecuteAgentResponse {
    execution_id: String,
    status: String
}

// 代理历史响应
AgentHistoryResponse {
    history: Vec<AgentExecution>
}

// 代理执行
AgentExecution {
    execution_id: String,
    status: String,
    timestamp: DateTime<Utc>
}

运行时提供者接口

API 实现了一个具有以下方法的 RuntimeApiProvider trait：

  • execute_workflow() - 使用给定参数执行工作流
  • get_agent_status() - 检索特定代理的状态信息
  • get_system_health() - 获取整体系统健康状态
  • list_agents() - 列出运行时中的所有活动代理
  • shutdown_agent() - 优雅地关闭特定代理
  • get_metrics() - 检索系统性能指标
  • create_agent() - 使用提供的配置创建新代理
  • update_agent() - 更新现有代理的配置
  • delete_agent() - 从运行时中删除特定代理
  • execute_agent() - 启动特定代理的执行
  • get_agent_history() - 获取特定代理的执行历史

入门指南

工具审查 API

  1. 从您的 Symbiont 管理员处获取 API 凭据
  2. 使用 /sessions 端点提交工具进行审查
  3. 通过 /sessions/{reviewId} 监控审查进度
  4. 从 /signing/{reviewId}/download 下载已签名工具

运行时 HTTP API

  1. 确保运行时是使用 http-api 功能构建的： 
    cargo build --features http-api
  2. 启动运行时服务器： 
    ./target/debug/symbiont-runtime --http-api
  3. 验证服务器正在运行： 
    curl http://127.0.0.1:8080/api/v1/health

支持

获取 API 支持和问题：