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건 요청
  • Pro 티어: 분당 1,000건 요청
  • Enterprise: 맞춤 제한

모든 응답에 속도 제한 헤더가 포함됩니다:

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 기반 애플리케이션을 구축하는 것을 도와드립니다.