Adverant
Adverant
返回开发者

API参考

所有100+ Adverant Nexus API端点的完整文档

认证

API Key认证

所有API请求都需要使用API Key进行认证。在请求头中包含您的API Key：

# Using curl
curl -X POST http://localhost:9100/api/brain/memory/store \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Example memory"}'

# Using JavaScript fetch
fetch('http://localhost:9100/api/brain/memory/store', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    content: 'Example memory'
  })
})

注意：在本地开发中，API Key认证是可选的。在生产环境中，请始终使用API Key和HTTPS。

速率限制

API请求受到速率限制以确保公平使用：

  • 免费层级：每分钟100个请求
  • 专业层级：每分钟1,000个请求
  • 企业版：自定义限制

每个响应中都包含速率限制头信息：

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

Memory API

使用VoyageAI嵌入存储、召回和搜索语义记忆

Base URL: http://localhost:9100/api/brain/memory
POST/api/brain/memory/store

Store a new memory with embeddings

参数：

contentstring必填Memory content to store
tagsstring[]Tags for categorization
metadataobjectAdditional metadata
POST/api/brain/memory/recall

Recall memories using semantic search

参数：

querystring必填Search query
limitnumberMax results (default: 10)
scoreThresholdnumberMin similarity score (0-1)
POST/api/brain/memory/search

Unified search across all memory types

参数：

querystring必填Search query
filtersobjectFilter by type, tags, date range
limitnumberMax results (default: 20)
GET/api/brain/memory/list

List all stored memories with pagination

参数：

limitnumberResults per page (default: 20)
offsetnumberPagination offset

Vision API

视频处理、帧提取和场景检测

Base URL: http://localhost:9100/api/brain/videoagent
POST/api/brain/videoagent/submit-job

Submit video for processing

参数：

filenamestring必填Video filename
videoUrlstringURL to video file
optionsobjectProcessing options
userIdstringUser ID for tracking
GET/api/brain/videoagent/status

Check video processing status

参数：

jobIdstring必填Job ID from submit-job
GET/api/brain/videoagent/result

Get completed video processing results

参数：

jobIdstring必填Job ID from submit-job
DELETE/api/brain/videoagent/cancel

Cancel a running video processing job

参数：

jobIdstring必填Job ID to cancel

Orchestrator API

多代理任务协调和执行

Base URL: http://localhost:9100/api/brain/orchestrate
POST/api/brain/orchestrate/submit

Submit task for multi-agent orchestration

参数：

taskstring必填Task description
maxAgentsnumberMax agents (default: 3)
timeoutnumberTimeout in ms (default: 180000)
contextobjectAdditional context
GET/api/brain/orchestrate/status

Check orchestration task status

参数：

jobIdstring必填Job ID from submit
GET/api/brain/orchestrate/result

Get completed orchestration results

参数：

jobIdstring必填Job ID from submit
POST/api/brain/orchestrate/agent/collaborate

Multi-agent collaboration on complex tasks

参数：

objectivestring必填Collaboration objective
agentsarrayAgent configuration
iterationsnumberIterations (default: 2)

Documents API

文档处理、分块和检索

Base URL: http://localhost:9100/api/brain/fileprocess
POST/api/brain/fileprocess/submit-url

Submit document URL for processing

参数：

fileUrlstring必填Document URL
filenamestring必填Document filename
metadataobjectDocument metadata
userIdstringUser ID for tracking
POST/api/brain/fileprocess/submit-file

Submit document file for processing

参数：

filenamestring必填Document filename
fileSizenumberFile size in bytes
mimeTypestringMIME type
metadataobjectDocument metadata
GET/api/brain/fileprocess/status

Check document processing status

参数：

jobIdstring必填Job ID from submit
POST/api/brain/fileprocess/store-document

Store document with intelligent chunking

参数：

contentstring必填Document content
titlestringDocument title
metadataobjectDocument metadata

Geospatial API

地理编码、坐标转换和空间分析

Base URL: http://localhost:9100/api/brain/geospatial
POST/api/brain/geospatial/geocode

Convert address to coordinates

参数：

addressstring必填Address to geocode
POST/api/brain/geospatial/reverse-geocode

Convert coordinates to address

参数：

latitudenumber必填Latitude
longitudenumber必填Longitude
POST/api/brain/geospatial/distance

Calculate distance between coordinates

参数：

fromobject必填Start coordinates
toobject必填End coordinates
unitstringkm or miles (default: km)
POST/api/brain/geospatial/proximity

Find points within radius

参数：

centerobject必填Center coordinates
radiusnumber必填Radius in km
pointsarray必填Points to check

Learning API

渐进式知识构建和召回

Base URL: http://localhost:9100/api/brain/learning
POST/api/brain/learning/trigger

Trigger progressive learning on a topic

参数：

topicstring必填Learning topic
prioritynumber必填Priority 1-10
triggerstring必填Trigger reason
contextobjectAdditional context
POST/api/brain/learning/recall

Recall learned knowledge on a topic

参数：

topicstring必填Topic to recall
layerstringOVERVIEW|PROCEDURES|TECHNIQUES|EXPERT|all
maxResultsnumberMax results (default: 10)

Connect API

MCP工具执行和服务器管理

Base URL: http://localhost:9100/api/brain/connect
POST/api/brain/connect/execute

Execute an MCP tool

参数：

toolstring必填Tool name
parametersobject必填Tool parameters
GET/api/brain/connect/tools

List all available MCP tools

GET/api/brain/connect/servers

List all MCP servers

POST/api/brain/connect/server/add

Add a new MCP server

参数：

namestring必填Server name
configobject必填Server configuration

响应格式

标准JSON响应

所有API端点返回具有以下结构的JSON响应：

{
  "success": true,
  "data": {
    // Response data
  },
  "metadata": {
    "requestId": "req_abc123",
    "timestamp": "2025-11-07T10:00:00Z",
    "processingTime": 123
  }
}

// Error response
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "The 'query' parameter is required",
    "details": {}
  },
  "metadata": {
    "requestId": "req_abc123",
    "timestamp": "2025-11-07T10:00:00Z"
  }
}

Server-Sent Events (SSE) 流式传输

长时间运行的操作支持通过SSE进行实时进度更新：

// Connect to SSE stream
const eventSource = new EventSource(
  'http://localhost:9100/api/brain/orchestrate/stream?jobId=job_abc123'
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Progress:', data);
};

// SSE event format
{
  "type": "progress",
  "jobId": "job_abc123",
  "state": "in_progress",
  "progress": 45,
  "message": "Agent 2/5 completed research phase",
  "metadata": {
    "agentId": "agent_xyz",
    "phase": "research"
  }
}

错误代码

400 Bad Request

无效参数或格式错误的请求

401 Unauthorized

缺少或无效的API Key

403 Forbidden

此操作的权限不足

404 Not Found

资源未找到

429 Too Many Requests

超出速率限制

500 Internal Server Error

服务器错误 - 请联系支持

503 Service Unavailable

服务暂时不可用

需要集成帮助？

我们的团队随时帮助您使用Adverant Nexus构建出色的AI驱动应用程序。