Documentación de la API de Vulgate

Bienvenido a la documentación de la API de Vulgate. Vulgate es una plataforma de inteligencia documental que te permite ingestar, buscar e interactuar con tus bibliotecas de documentos a través de una API potente.

Sube y procesa documentos de cualquier formato — PDFs, imágenes, audio y más — luego consúltalos con búsqueda semántica o por palabras clave, o mantén conversaciones impulsadas por IA basadas en tu contenido con citas completas de las fuentes.

La API está diseñada para ser compatible con OpenAI, por lo que puedes integrarla con cualquier SDK existente que soporte la interfaz de Chat Completions.

Autenticación

Todos los endpoints de la API requieren autenticación a través de un token Bearer en el encabezado Authorization:

Authorization: Bearer <su-clave-de-api>

Configuración de tu clave API

Configure su clave de API como una variable de entorno. Este enfoque agiliza el uso de la API al eliminar la necesidad de incluir su clave en cada solicitud. Además, mejora la seguridad al minimizar el riesgo de incluir inadvertidamente su clave en su código base.

En el terminal de su elección:

export VULGATE_API_KEY=<su-clave-de-api>

O, en el archivo .env de su proyecto:

VULGATE_API_KEY=<su-clave-de-api>

Reemplace <su-clave-de-api> con su clave de API real, que puede generar en el panel de su equipo navegando a Configuración > API. Consulte la Consola de API para obtener detalles completos sobre la administración de claves.

Secciones