Adverant
Adverant
Zurück zu Entwickler

API-Referenz

Vollständige Dokumentation für alle 100+ Adverant Nexus API-Endpunkte

Authentifizierung

API-Key-Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit einem API-Key. Fügen Sie Ihren API-Key im Request-Header hinzu:

# 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'
  })
})

Hinweis: Für die lokale Entwicklung ist die API-Key-Authentifizierung optional. In der Produktion verwenden Sie immer API-Keys und HTTPS.

Rate Limiting

API-Anfragen sind zum Schutz der fairen Nutzung begrenzt:

  • Free-Stufe: 100 Anfragen pro Minute
  • Pro-Stufe: 1.000 Anfragen pro Minute
  • Enterprise: Individuelle Limits

Rate-Limit-Header sind in jeder Antwort enthalten:

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

Memory API

Speichern, Abrufen und Durchsuchen semantischer Erinnerungen mit VoyageAI-Embeddings

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

Store a new memory with embeddings

Parameter:

contentstringerforderlichMemory content to store
tagsstring[]Tags for categorization
metadataobjectAdditional metadata
POST/api/brain/memory/recall

Recall memories using semantic search

Parameter:

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

Unified search across all memory types

Parameter:

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

List all stored memories with pagination

Parameter:

limitnumberResults per page (default: 20)
offsetnumberPagination offset

Vision API

Videoverarbeitung, Frame-Extraktion und Szenenerkennung

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

Submit video for processing

Parameter:

filenamestringerforderlichVideo filename
videoUrlstringURL to video file
optionsobjectProcessing options
userIdstringUser ID for tracking
GET/api/brain/videoagent/status

Check video processing status

Parameter:

jobIdstringerforderlichJob ID from submit-job
GET/api/brain/videoagent/result

Get completed video processing results

Parameter:

jobIdstringerforderlichJob ID from submit-job
DELETE/api/brain/videoagent/cancel

Cancel a running video processing job

Parameter:

jobIdstringerforderlichJob ID to cancel

Orchestrator API

Multi-Agenten-Aufgabenkoordination und -ausführung

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

Submit task for multi-agent orchestration

Parameter:

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

Check orchestration task status

Parameter:

jobIdstringerforderlichJob ID from submit
GET/api/brain/orchestrate/result

Get completed orchestration results

Parameter:

jobIdstringerforderlichJob ID from submit
POST/api/brain/orchestrate/agent/collaborate

Multi-agent collaboration on complex tasks

Parameter:

objectivestringerforderlichCollaboration objective
agentsarrayAgent configuration
iterationsnumberIterations (default: 2)

Documents API

Dokumentenverarbeitung, Chunking und Abruf

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

Submit document URL for processing

Parameter:

fileUrlstringerforderlichDocument URL
filenamestringerforderlichDocument filename
metadataobjectDocument metadata
userIdstringUser ID for tracking
POST/api/brain/fileprocess/submit-file

Submit document file for processing

Parameter:

filenamestringerforderlichDocument filename
fileSizenumberFile size in bytes
mimeTypestringMIME type
metadataobjectDocument metadata
GET/api/brain/fileprocess/status

Check document processing status

Parameter:

jobIdstringerforderlichJob ID from submit
POST/api/brain/fileprocess/store-document

Store document with intelligent chunking

Parameter:

contentstringerforderlichDocument content
titlestringDocument title
metadataobjectDocument metadata

Geospatial API

Geocodierung, Koordinatentransformation und räumliche Analyse

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

Convert address to coordinates

Parameter:

addressstringerforderlichAddress to geocode
POST/api/brain/geospatial/reverse-geocode

Convert coordinates to address

Parameter:

latitudenumbererforderlichLatitude
longitudenumbererforderlichLongitude
POST/api/brain/geospatial/distance

Calculate distance between coordinates

Parameter:

fromobjecterforderlichStart coordinates
toobjecterforderlichEnd coordinates
unitstringkm or miles (default: km)
POST/api/brain/geospatial/proximity

Find points within radius

Parameter:

centerobjecterforderlichCenter coordinates
radiusnumbererforderlichRadius in km
pointsarrayerforderlichPoints to check

Learning API

Progressiver Wissensaufbau und -abruf

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

Trigger progressive learning on a topic

Parameter:

topicstringerforderlichLearning topic
prioritynumbererforderlichPriority 1-10
triggerstringerforderlichTrigger reason
contextobjectAdditional context
POST/api/brain/learning/recall

Recall learned knowledge on a topic

Parameter:

topicstringerforderlichTopic to recall
layerstringOVERVIEW|PROCEDURES|TECHNIQUES|EXPERT|all
maxResultsnumberMax results (default: 10)

Connect API

MCP-Tool-Ausführung und Serververwaltung

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

Execute an MCP tool

Parameter:

toolstringerforderlichTool name
parametersobjecterforderlichTool 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

Parameter:

namestringerforderlichServer name
configobjecterforderlichServer configuration

Antwortformate

Standard-JSON-Antwort

Alle API-Endpunkte geben JSON-Antworten mit folgender Struktur zurück:

{
  "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

Lang laufende Operationen unterstützen Echtzeit-Fortschrittsupdates über 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"
  }
}

Fehlercodes

400 Bad Request

Ungültige Parameter oder fehlerhafte Anfrage

401 Unauthorized

Fehlender oder ungültiger API-Key

403 Forbidden

Unzureichende Berechtigungen für diese Operation

404 Not Found

Ressource nicht gefunden

429 Too Many Requests

Rate-Limit überschritten

500 Internal Server Error

Serverfehler — bitte kontaktieren Sie den Support

503 Service Unavailable

Dienst vorübergehend nicht verfügbar

Hilfe bei der Integration benötigt?

Unser Team hilft Ihnen dabei, großartige KI-gestützte Anwendungen mit Adverant Nexus zu bauen.