Descargar ahoraVersión 2.18.1
FilePulseVersión 2.18.1
Descargar ahora

FilePulse Local HTTP API

Los desarrolladores de la API

Permite que la IA, los scripts, los lanzadores y las herramientas internas invoquen las capacidades de búsqueda y vista previa de FilePulse a través de la HTTP API local que utiliza la interfaz web FilePulse.

Base de ejemplo URLhttp://127.0.0.1:80

El ejemplo utiliza el puerto 80 HTTP predeterminado en config_default.json. Durante la implementación real, consulte el puerto en el archivo config.json local del usuario.

Comenzar aquí

Proceso de autenticación

Primero explore, luego inicie sesión para obtener el token y luego coloque el token devuelto directamente en el encabezado de Autorización. No agregue el prefijo Portador.

01
GET/api/ver

Detectar y leer la versión

Devolver versión y plan. Las versiones en línea también pueden devolver uid y licencia_remaining_hours. Esta interfaz no requiere un token.

Ejemplo de solicitud: /api/ver
curl http://127.0.0.1:80/api/ver
02
POST/api/login

Crear token de acceso

Enviar nombre de usuario y contraseña usando JSON. La respuesta contiene nombre_servidor y token_acceso.

Ejemplo de solicitud: /api/login
curl -X POST http://127.0.0.1:80/api/login \
  -H "Content-Type: application/json" \
  -d '{"username":"root","password":"root"}'
03
HEADERAuthorization: <access_token>

Llamada protegida API

Las solicitudes posteriores colocan directamente el token en el encabezado de Autorización o en el parámetro de consulta de Autorización.

Ejemplo de solicitud: Authorization: <access_token>
curl http://127.0.0.1:80/api/search_scope_targets \
  -H "Authorization: $FILEPULSE_TOKEN"

Interfaces principales

Puntos finales públicos comunes

Estas interfaces son las más adecuadas para flujos de trabajo asistidos por IA: descubra ámbitos, busque, obtenga una vista previa, descargue y abra archivos solo después de la confirmación del usuario.

GET/api/search_scope_targets
Token

Discos y rangos de búsqueda

Devuelve objetivos de búsqueda indexados. Cuando necesite limitar el alcance de la búsqueda, coloque el índice de la unidad devuelta en drive_scope.

Campos clave

  • El número de disco devuelto se puede pasar a drive_scope.drive_indices.
  • Flujo de trabajo AI Si desea evitar objetivos de montaje remoto, puede usar drive_scope.local_only.
Ejemplo de solicitud: /api/search_scope_targets
curl http://127.0.0.1:80/api/search_scope_targets \
  -H "Authorization: $FILEPULSE_TOKEN"
POST/api/search
Token

Búsqueda de ruta y nombre de archivo

Búsqueda por metadatos de archivo/carpeta, compatible con comodines o patrones regulares, filtrado, clasificación y paginación.

Campos clave

  • modo: expresión regular o comodín
  • search_by: nombre o ruta_completa
  • sort_by: nombre, ruta_completa, tamaño, modificado o extensión
  • tipo: 0 significa archivos y carpetas, 1 significa carpetas, 2 significa archivos
  • pin_priority/use_groups controla la prioridad de los pines y el comportamiento de agrupación
  • la interfaz de solicitud inline_icon.size devuelve datos de iconos en línea
  • inicio/fin es el subíndice del resultado que incluye el límite
Ejemplo de búsqueda de archivos
curl -X POST 'http://127.0.0.1:80/api/search' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --data-raw '{
    "search_content": "a",
    "mode": "wildcard",
    "case_sensitive": false,
    "search_by": "name",
    "sort_by": "modified",
    "sort_asc": false,
    "content_plugin": [""],
    "kind": 0,
    "pin_priority": false,
    "use_groups": false,
    "start": 0,
    "end": 13,
    "inline_icon": {
      "size": 32
    }
  }'
POST/api/content_search
Token

Búsqueda de contenido de texto completo

Buscar texto de documentos, texto OCR y contenido indexado de procesadores de contenido configurados. Se recomienda activar el fragmento cuando la IA necesite acceder al contexto.

Campos clave

  • Cuando lineal es falso, se admiten regular, regex, prefijo y difuso
  • Cuando lineal es verdadero, se admiten los modos transversales comodín y regex
  • sort_by: none, file o scoring
  • file_search_condition puede reutilizar las condiciones de filtro de /api/search
  • el fragmento controla si se devuelve el contexto de visita
  • pin_priority/use_groups controla la prioridad de los pines y el comportamiento de agrupación
  • la interfaz de solicitud inline_icon.size devuelve datos de iconos en línea
Ejemplo de solicitud: /api/content_search
curl -X POST 'http://127.0.0.1:80/api/content_search' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --data-raw '{
    "linear": false,
    "search_content": "a",
    "mode": "regular",
    "fuzzy_distance": 2,
    "score_top_k": 100,
    "sort_by": "score",
    "sort_asc": false,
    "snippet": false,
    "snippet_radius": 100,
    "pin_priority": false,
    "use_groups": false,
    "start": 0,
    "end": 13,
    "inline_icon": {
      "size": 32
    }
  }'
GET/api/visual_status
Token

Estado de búsqueda visual

Devuelve si la búsqueda visual está habilitada, el progreso de la indexación, la cantidad de archivos que se pueden buscar, la cantidad de líneas vectoriales y la disponibilidad de ffmpeg.

Campos clave

  • Comprueba los archivos habilitados y listos antes de enviar consultas de imágenes o vídeos.
  • Puede utilizar indexing/current_file_count/total_file_count para determinar si necesita esperar a que se complete el índice.
Ejemplo de solicitud: /api/visual_status
curl http://127.0.0.1:80/api/visual_status \
  -H "Authorization: $FILEPULSE_TOKEN"
POST/api/visual_search
Token

Búsqueda similar de imágenes y vídeos

Utilice datos de formularios de varias partes para enviar imágenes, capturas de pantalla, vídeos o FilePulse la ruta de consulta absoluta en el host.

Campos clave

  • Debe proporcionar el archivo o la ruta de consulta
  • drive_indices recibe JSON cadena de matriz
  • top_k limita el número de devoluciones
  • fast_mode intercambia precisión por velocidad
  • search_detail y min_match_count Coincidencia de vídeo ajustable
Ejemplo de solicitud: /api/visual_search
curl -X POST 'http://127.0.0.1:80/api/visual_search' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -F 'file=@query.jpg' \
  -F 'top_k=20' \
  -F 'drive_indices=[0]' \
  -F 'fast_mode=true'
GET/api/download/{encodedPath}
Token

Descargar o obtener una vista previa de archivos

La transmisión devuelve rutas de archivos nativas o proxy. Introduzca la ruta completa en la ruta después de codificar y llevar la autorización URL. El servicio de archivos subyacente admite solicitudes de rango.

Campos clave

  • x-proxy solo se usa con server_name remoto registrado.
  • Solo acepta rutas de archivos; Las carpetas devolverán un error.
Ejemplo de solicitud: /api/download/{encodedPath}
curl 'http://127.0.0.1:80/api/download/D%3A%5Cdocs%5Creport.pdf' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --output report.pdf
POST/api/folder_preview
Token

Vista previa de carpetas secundarias

Devuelve una lista pequeña y ordenada de carpetas para evitar extraer todas las carpetas secundarias a la vez.

Campos clave

  • ruta requerida
  • límite predeterminado 80, máximo 200
  • La respuesta contiene total_children y está truncada
Ejemplo de solicitud: /api/folder_preview
curl -X POST http://127.0.0.1:80/api/folder_preview \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{"path":"D:\\docs","limit":50}'
POST/api/content_match_preview
Token

Vista previa del contexto de acceso al contenido

Obtener contexto HTML/texto para un determinado resultado de búsqueda de contenido, de modo que AI pueda verificar la ubicación del acceso antes de solicitar abrir el archivo.

Campos clave

  • ruta, modificado, contenido_búsqueda, modo requerido
  • lineal y fuzzy_distance deben ser coherentes con la solicitud de búsqueda de contenido original
Ejemplo de solicitud: /api/content_match_preview
curl -X POST http://127.0.0.1:80/api/content_match_preview \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{
    "path": "D:\\docs\\report.pdf",
    "modified": 1717113600,
    "search_content": "invoice",
    "mode": "regular",
    "linear": false,
    "fuzzy_distance": 2
  }'
POST/api/openfile
Token

Abra el archivo en el host

Inicie el archivo o programa ejecutable en la máquina donde se encuentra FilePulse. Esta operación tiene efectos secundarios y las herramientas de inteligencia artificial deberían pedir a los usuarios que primero la confirmen explícitamente.

Campos clave

  • ruta requerida
  • work_folder se puede dejar en blanco y el directorio principal se inferirá automáticamente
  • admin significa intentar comenzar con derechos de administrador en plataformas compatibles
Ejemplo de solicitud: /api/openfile
curl -X POST http://127.0.0.1:80/api/openfile \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{"path":"D:\\docs\\report.pdf","work_folder":"","admin":false}'
POST/api/quick_launcher
Token

Búsqueda de inicio rápido

Busque aplicaciones, carpetas y accesos directos iniciables, y el cuerpo de la solicitud básicamente sigue la estructura de /api/search.

Campos clave

  • El cuerpo de la solicitud sigue SearchReqJson
  • Adecuado para que AI ubique primero aplicaciones o directorios de uso común y luego solicite al usuario que confirme si desea comenzar.
Ejemplo de solicitud: /api/quick_launcher
curl -X POST http://127.0.0.1:80/api/quick_launcher \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{
    "search_content": "chrome",
    "mode": "wildcard",
    "case_sensitive": false,
    "search_by": "full_path",
    "sort_by": "modified",
    "sort_asc": false,
    "content_plugin": [""],
    "kind": 0,
    "start": 0,
    "end": 9
  }'

Recomendaciones de llamadas de IA

Flujo de trabajo de IA recomendado

Mantenga el modelo en un camino estrecho: autentique, busque, inspeccione y luego solicite la confirmación del usuario antes de abrir o cambiar el archivo.

ver
login
search / content_search / visual_search
preview / download
user-confirmed openfile

No proporcione la contraseña al modelo durante mucho tiempo

Se recomienda que el usuario o el programa anfitrión proporcione un token de sesión breve. No guarde contraseñas en la memoria del modelo, registros largos ni palabras de aviso reutilizables.

primero se debe confirmar la apertura del archivo

Abrir un archivo puede iniciar un programa o exponer datos locales. La IA debería mostrar la ruta exacta y esperar la aprobación del usuario.

Solicite paginación pequeña primero

Se recomienda utilizar el extremo 9 o el extremo 19 primero, verificar el nombre del archivo y el resumen, y luego solicitar más resultados según sea necesario.

Esta página no cubre

API avanzada e interna

Las siguientes interfaces no se incluyen intencionalmente en la página de entrada pública, porque pertenecen a comunicación interna, operaciones destructivas, interfaces de administración o son más adecuadas para escribir documentos avanzados por separado.

sync/**_internalEscritura de configuraciónCompartir configuraciónConfiguración LLMLimpieza de archivos duplicadosupload