Adverant
Adverant
Volver a Desarrolladores

Referencia API

Documentación completa de todos los más de 100 endpoints de la API de Adverant Nexus

Autenticación

Autenticación con API Key

Todas las solicitudes API requieren autenticación mediante una API key. Incluye tu API key en el encabezado de la solicitud:

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

Nota: Para desarrollo local, la autenticación con API key es opcional. En producción, usa siempre API keys y HTTPS.

Limitación de Velocidad

Las solicitudes API están limitadas para garantizar un uso justo:

  • Plan gratuito: 100 solicitudes por minuto
  • Plan Pro: 1.000 solicitudes por minuto
  • Empresarial: Límites personalizados

Los encabezados de límite de velocidad se incluyen en cada respuesta:

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

API de Memoria

Almacena, recupera y busca memorias semánticas con embeddings VoyageAI

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

Store a new memory with embeddings

Parámetros:

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

Recall memories using semantic search

Parámetros:

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

Unified search across all memory types

Parámetros:

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

List all stored memories with pagination

Parámetros:

limitnumberResults per page (default: 20)
offsetnumberPagination offset

API de Visión

Procesamiento de video, extracción de fotogramas y detección de escenas

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

Submit video for processing

Parámetros:

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

Check video processing status

Parámetros:

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

Get completed video processing results

Parámetros:

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

Cancel a running video processing job

Parámetros:

jobIdstringrequeridoJob ID to cancel

API de Orquestador

Coordinación y ejecución de tareas multi-agente

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

Submit task for multi-agent orchestration

Parámetros:

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

Check orchestration task status

Parámetros:

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

Get completed orchestration results

Parámetros:

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

Multi-agent collaboration on complex tasks

Parámetros:

objectivestringrequeridoCollaboration objective
agentsarrayAgent configuration
iterationsnumberIterations (default: 2)

API de Documentos

Procesamiento, fragmentación y recuperación de documentos

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

Submit document URL for processing

Parámetros:

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

Submit document file for processing

Parámetros:

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

Check document processing status

Parámetros:

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

Store document with intelligent chunking

Parámetros:

contentstringrequeridoDocument content
titlestringDocument title
metadataobjectDocument metadata

API Geoespacial

Geocodificación, transformación de coordenadas y análisis espacial

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

Convert address to coordinates

Parámetros:

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

Convert coordinates to address

Parámetros:

latitudenumberrequeridoLatitude
longitudenumberrequeridoLongitude
POST/api/brain/geospatial/distance

Calculate distance between coordinates

Parámetros:

fromobjectrequeridoStart coordinates
toobjectrequeridoEnd coordinates
unitstringkm or miles (default: km)
POST/api/brain/geospatial/proximity

Find points within radius

Parámetros:

centerobjectrequeridoCenter coordinates
radiusnumberrequeridoRadius in km
pointsarrayrequeridoPoints to check

API de Aprendizaje

Construcción progresiva de conocimiento y recuperación

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

Trigger progressive learning on a topic

Parámetros:

topicstringrequeridoLearning topic
prioritynumberrequeridoPriority 1-10
triggerstringrequeridoTrigger reason
contextobjectAdditional context
POST/api/brain/learning/recall

Recall learned knowledge on a topic

Parámetros:

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

API de Connect

Ejecución de herramientas MCP y gestión de servidores

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

Execute an MCP tool

Parámetros:

toolstringrequeridoTool name
parametersobjectrequeridoTool 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

Parámetros:

namestringrequeridoServer name
configobjectrequeridoServer configuration

Formatos de Respuesta

Respuesta JSON Estándar

Todos los endpoints API devuelven respuestas JSON con la siguiente estructura:

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

Las operaciones de larga duración soportan actualizaciones de progreso en tiempo real vía 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"
  }
}

Códigos de Error

400 Bad Request

Parámetros inválidos o solicitud mal formada

401 Unauthorized

API key faltante o inválida

403 Forbidden

Permisos insuficientes para esta operación

404 Not Found

Recurso no encontrado

429 Too Many Requests

Límite de velocidad excedido

500 Internal Server Error

Error del servidor — por favor contacta soporte

503 Service Unavailable

Servicio temporalmente no disponible

¿Necesitas ayuda con la integración?

Nuestro equipo está aquí para ayudarte a construir aplicaciones increíbles potenciadas por IA con Adverant Nexus.