Documentación / Primeros pasos

Inicio rápido

Vista previa para desarrolladores

Tres pasos: obtener un token, ejecutar una búsqueda, hacer una pregunta. Los endpoints marcados como “Disponible” funcionan hoy; los marcados como “Planificado” llegarán con el núcleo abierto.

1
Obtener un token
El token está en el archivo token del directorio de datos. Se genera automáticamente en el primer inicio y solo puede leerlo el usuario actual.
Terminal
cat <directorio-de-datos>/token
# Todos los endpoints de /api/v1 lo requieren; de forma predeterminada solo escucha en 127.0.0.1:8090
2
Búsqueda
Busque en su material en lenguaje natural. Los resultados incluyen el archivo, la ubicación y el pasaje, y no dependen de los nombres de archivo.
Terminal
curl http://127.0.0.1:8090/api/v1/search \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "condiciones de pago del contrato con el proveedor", "top_k": 5}'
3
Preguntas
Devuelve la respuesta en flujo. Con search activado, responde solo con sus archivos y cita sus fuentes.
Terminal
curl -N http://127.0.0.1:8090/api/v1/chat/stream \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"messages": [{"role": "user", "content": "¿Qué se decidió en la reunión de la semana pasada?"}],
       "search": true}'

Estado de la API

APIQué haceEstado
MCP · ownward-mcp
Permite que los agentes compatibles con MCP usen directamente la búsqueda, las preguntas y la biblioteca; las herramientas con efectos secundarios no se exponen.
Disponible
POST /api/v1/search
Una sola búsqueda en documentos, imágenes, audio y video.
Disponible
POST /api/v1/search-image
Buscar imágenes por imagen.
Disponible
POST /api/v1/search/video-clips
Ubique el fragmento exacto dentro de un video.
Disponible
POST /api/v1/chat/stream
Preguntas y respuestas en flujo por SSE, con fuentes.
Disponible
POST /api/v1/generate
Generación de imágenes y video. Una duración que el equipo no puede completar se rechaza de inmediato y se devuelve el máximo compatible.
Disponible
GET /hub/index.json
Catálogo de escenarios; verificado con sha256 antes de guardarse.
Disponible
SDK · Python / JS / C++
Empaqueta los endpoints anteriores como bibliotecas cliente para cada lenguaje.
Planificado
API compatible con OpenAI
Las herramientas existentes se conectan cambiando la dirección del endpoint.
Planificado
Conectores MCP
Conecte herramientas y fuentes de datos de terceros mediante MCP.
Planificado

Modelos

Cada tipo de tarea tiene una opción predeterminada que se puede reemplazar en la configuración. Los modelos en la nube son opcionales y están desactivados de forma predeterminada.

Búsqueda
Texto y multimodal
Embeddings · reordenamiento · dispersos · visión de páginas de documentos
Imágenes
Comprensión de imágenes
Semántica imagen-texto · rostros · OCR · descripciones
Audio
Comprensión de audio
Transcripción · alineación por palabra · hablantes · eventos
Video
Análisis de video
Detección de tomas · detección y seguimiento
Chat
Preguntas y planificación
Modelos de chat locales
Generar
Imagen y video
Imágenes · video · síntesis de voz
Documentos
Comprensión del diseño de página
Estructura de página · comprensión por elemento
Intercambiable
Sin dependencia de un proveedor
Cambie por tipo en la configuración
Inscripción a la vista previa para desarrolladores próximamente
La inscripción se está preparando y se anunciará aquí cuando esté disponible.