API Vulgate — panoramica

La piattaforma Vulgate espone tutto ciò che fa l'app web tramite un'API REST + JSON. Che tu stia costruendo uno strumento interno, una pipeline di ricerca o un prodotto rivolto ai clienti, l'API è il tuo aggancio per l'elaborazione, la ricerca e la chat AI.

Le tre API

API	Cosa fa	Riferimento
Ingest	Carica file, avvia lavori di elaborazione, monitora l'avanzamento, gestisci documenti.	/developers/ingest/overview
Search	Esegui ricerche neurali o per parole chiave nella tua Libreria. Restituisci passaggi o ID documento.	/developers/search/overview
Chat	Endpoint Chat Completions compatibile con OpenAI radicato nella tua Libreria.	/developers/chat/overview

La Chat API usa la struttura OpenAI Chat Completions, quindi la maggior parte degli SDK esistenti (Python openai, Vercel ai, LangChain, ecc.) funziona semplicemente puntando su https://vulgate.ai/api con la tua chiave API Vulgate.

URL base

https://vulgate.ai/api

Tutti gli endpoint sono solo HTTPS.

Autenticazione

Ogni richiesta ha bisogno di un token Bearer nell'header Authorization:

Authorization: Bearer <your-api-key>

Vedi Creare una chiave API per come generarne una.

Esempio rapido

Esegui una ricerca nella tua Libreria:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=eucharistic theology" \
  --data-urlencode "mode=neural" \
  --data-urlencode "per_page=5"

La risposta è un oggetto JSON con una lista di passaggi risultato, ciascuno con l'ID documento, un indice, il contenuto renderizzato e i metadati del documento sorgente. Vedi il riferimento Search API per ogni campo.

Streaming

La Chat API supporta risposte in streaming nel formato OpenAI Chat Completions. Imposta stream: true nel corpo della richiesta. Vedi la panoramica Chat API.

Limiti di rate

La Chat API applica un limite di rate a finestra scorrevole di 10 richieste per 10 secondi per team, con un timeout di esecuzione per richiesta di 120 secondi. La Search API ha un timeout di esecuzione per richiesta di 40 secondi. Quando superi un limite, l'API restituisce HTTP 429.

SDK

Vulgate attualmente non fornisce un SDK di prima parte, ma la Chat API è intenzionalmente compatibile con il client OpenAI. Punta l'SDK OpenAI su https://vulgate.ai/api e passa la tua chiave API Vulgate:

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.VULGATE_API_KEY,
  baseURL: "https://vulgate.ai/api",
});

Per le API Ingest e Search, qualsiasi client HTTP (fetch, axios, requests) funziona.