Adverant
Adverant
Retour aux Développeurs

Référence API

Documentation complète pour tous les 100+ points d'accès API d'Adverant Nexus

Authentification

Authentification par Clé API

Toutes les requêtes API nécessitent une authentification par clé API. Incluez votre clé API dans l'en-tête de la requête :

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

Note : Pour le développement local, l'authentification par clé API est facultative. En production, utilisez toujours des clés API et HTTPS.

Limitation de Débit

Les requêtes API sont soumises à une limitation de débit pour garantir une utilisation équitable :

  • Palier gratuit : 100 requêtes par minute
  • Palier Pro : 1 000 requêtes par minute
  • Entreprise : Limites personnalisées

Les en-têtes de limitation de débit sont inclus dans chaque réponse :

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

API Memory

Stocker, rappeler et rechercher des mémoires sémantiques avec les embeddings VoyageAI

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

Store a new memory with embeddings

Paramètres :

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

Recall memories using semantic search

Paramètres :

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

Unified search across all memory types

Paramètres :

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

List all stored memories with pagination

Paramètres :

limitnumberResults per page (default: 20)
offsetnumberPagination offset

API Vision

Traitement vidéo, extraction de trames et détection de scènes

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

Submit video for processing

Paramètres :

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

Check video processing status

Paramètres :

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

Get completed video processing results

Paramètres :

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

Cancel a running video processing job

Paramètres :

jobIdstringrequisJob ID to cancel

API Orchestrator

Coordination et exécution de tâches multi-agents

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

Submit task for multi-agent orchestration

Paramètres :

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

Check orchestration task status

Paramètres :

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

Get completed orchestration results

Paramètres :

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

Multi-agent collaboration on complex tasks

Paramètres :

objectivestringrequisCollaboration objective
agentsarrayAgent configuration
iterationsnumberIterations (default: 2)

API Documents

Traitement de documents, découpage et récupération

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

Submit document URL for processing

Paramètres :

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

Submit document file for processing

Paramètres :

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

Check document processing status

Paramètres :

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

Store document with intelligent chunking

Paramètres :

contentstringrequisDocument content
titlestringDocument title
metadataobjectDocument metadata

API Geospatial

Géocodage, transformation de coordonnées et analyse spatiale

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

Convert address to coordinates

Paramètres :

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

Convert coordinates to address

Paramètres :

latitudenumberrequisLatitude
longitudenumberrequisLongitude
POST/api/brain/geospatial/distance

Calculate distance between coordinates

Paramètres :

fromobjectrequisStart coordinates
toobjectrequisEnd coordinates
unitstringkm or miles (default: km)
POST/api/brain/geospatial/proximity

Find points within radius

Paramètres :

centerobjectrequisCenter coordinates
radiusnumberrequisRadius in km
pointsarrayrequisPoints to check

API Learning

Construction progressive des connaissances et rappel

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

Trigger progressive learning on a topic

Paramètres :

topicstringrequisLearning topic
prioritynumberrequisPriority 1-10
triggerstringrequisTrigger reason
contextobjectAdditional context
POST/api/brain/learning/recall

Recall learned knowledge on a topic

Paramètres :

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

API Connect

Exécution d'outils MCP et gestion de serveurs

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

Execute an MCP tool

Paramètres :

toolstringrequisTool name
parametersobjectrequisTool 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

Paramètres :

namestringrequisServer name
configobjectrequisServer configuration

Formats de Réponse

Réponse JSON Standard

Tous les points d'accès API retournent des réponses JSON avec la structure suivante :

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

Streaming Server-Sent Events (SSE)

Les opérations longues prennent en charge les mises à jour de progression en temps réel via 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"
  }
}

Codes d'Erreur

400 Bad Request

Paramètres invalides ou requête malformée

401 Unauthorized

Clé API manquante ou invalide

403 Forbidden

Permissions insuffisantes pour cette opération

404 Not Found

Ressource non trouvée

429 Too Many Requests

Limitation de débit dépassée

500 Internal Server Error

Erreur serveur — veuillez contacter le support

503 Service Unavailable

Service temporairement indisponible

Besoin d'aide pour l'intégration ?

Notre équipe est là pour vous aider à construire des applications exceptionnelles alimentées par l'IA avec Adverant Nexus.