Adverant
Adverant
กลับไปยังนักพัฒนา

อ้างอิง API

เอกสารฉบับสมบูรณ์สำหรับ API endpoints ทั้ง 100+ ของ Adverant Nexus

การยืนยันตัวตน

การยืนยันตัวตนด้วย 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 keys และ HTTPS เสมอ

การจำกัดอัตรา

คำขอ API ถูกจำกัดอัตราเพื่อให้การใช้งานเป็นธรรม:

  • ระดับฟรี: 100 คำขอต่อนาที
  • ระดับ Pro: 1,000 คำขอต่อนาที
  • Enterprise: ขีดจำกัดกำหนดเอง

ส่วนหัวจำกัดอัตราจะรวมอยู่ในทุกการตอบสนอง:

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

Memory API

จัดเก็บ เรียกคืน และค้นหาหน่วยความจำเชิงความหมายด้วย VoyageAI embeddings

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 endpoints ทั้งหมดส่งคืนการตอบสนอง 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) Streaming

การดำเนินงานที่ใช้เวลานานรองรับการอัปเดตความคืบหน้าเรียลไทม์ผ่าน 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 หรือ API key ไม่ถูกต้อง

403 Forbidden

สิทธิ์ไม่เพียงพอสำหรับการดำเนินการนี้

404 Not Found

ไม่พบทรัพยากร

429 Too Many Requests

เกินขีดจำกัดอัตรา

500 Internal Server Error

ข้อผิดพลาดของเซิร์ฟเวอร์ - กรุณาติดต่อฝ่ายสนับสนุน

503 Service Unavailable

บริการไม่พร้อมใช้งานชั่วคราว

ต้องการความช่วยเหลือในการรวมระบบ?

ทีมของเราพร้อมช่วยคุณสร้างแอปพลิเคชันที่ขับเคลื่อนด้วย AI ที่น่าทึ่งด้วย Adverant Nexus