Adverant
Adverant
開発者に戻る

APIリファレンス

Adverant Nexusの全100以上のAPIエンドポイントの完全なドキュメント

認証

APIキー認証

すべてのAPIリクエストにはAPIキーによる認証が必要です。リクエストヘッダーにAPIキーを含めてください：

# 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キー認証はオプションです。本番では常にAPIキーとHTTPSを使用してください。

レート制限

公平な使用を確保するため、APIリクエストにはレート制限が適用されます：

  • 無料プラン：毎分100リクエスト
  • Proプラン：毎分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キーが未設定または無効

403 Forbidden

この操作に対する権限が不足

404 Not Found

リソースが見つかりません

429 Too Many Requests

レート制限を超過

500 Internal Server Error

サーバーエラー — サポートにお問い合わせください

503 Service Unavailable

サービスが一時的に利用不可

統合にお困りですか？

Adverant Nexusで素晴らしいAI駆動アプリケーションを構築するお手伝いをします。