Endpoint

Autenticazione#

Tutti gli endpoint tranne /health richiedono una API key.

x-api-key: YOUR_API_KEY

# oppure
Authorization: Bearer YOUR_API_KEY

Tutti i dettagli in Autenticazione, inclusi gli header di workspace e la struttura condivisa degli errori.

Notifiche#

Invia notifiche all’app desktop, poi leggi e gestisci il feed.

• POST/api/public/notificationsInvia una notifica
• GET/api/public/notificationsElenca le notifiche
• GET/api/public/notifications/unread-countConteggio non lette
• GET/api/public/notifications/:idLeggi una notifica
• PATCH/api/public/notifications/:idSegna letta o non letta
• POST/api/public/notifications/read-allSegna tutto come letto
• DELETE/api/public/notifications/:idElimina

Cartelle#

Raccolte di conoscenza e le impostazioni che le indicizzano.

• GET/api/public/vectorsElenca le cartelle
• POST/api/public/vectorsCrea una cartella
• GET/api/public/vectors/:idLeggi una cartella
• PATCH/api/public/vectors/:idAggiorna una cartella
• DELETE/api/public/vectors/:idElimina una cartella

File#

Documenti dentro una cartella. Il caricamento viene elaborato in background.

• GET/api/public/vectors/:id/filesElenca i file
• POST/api/public/vectors/:id/filesCarica un file
• GET/api/public/vectors/:id/files/:fileIdMetadati del file
• PUT/api/public/vectors/:id/files/:fileIdSostituisci un file
• DELETE/api/public/vectors/:id/files/:fileIdElimina un file
• GET/api/public/vectors/:id/files/:fileId/contentScarica un file

Ricerca#

Recupero senza LLM: passaggi, punteggi, fonti.

• POST/api/public/vectors/:id/searchRicerca semantica in una cartella

Assistenti#

Configurazioni riutilizzabili di prompt, cartelle e strumenti.

• GET/api/public/assistantsElenca gli assistenti
• POST/api/public/assistantsCrea un assistente
• GET/api/public/assistants/:idLeggi un assistente
• PATCH/api/public/assistants/:idAggiorna un assistente
• DELETE/api/public/assistants/:idElimina un assistente

Chat#

Fai domande. Le risposte arrivano in streaming come Server-Sent Events.

• POST/api/ai/chatInvia un messaggio
• POST/api/ai/chat/:id/stopInterrompi una risposta
• POST/api/v1/chat/completionsCompletions compatibili OpenAI
• GET/api/v1/modelsElenco modelli compatibile OpenAI

Conversazioni#

Rileggi e gestisci quello che è stato chiesto.

• GET/api/public/chatsElenca le conversazioni
• GET/api/public/chats/:idLeggi una conversazione
• PATCH/api/public/chats/:idRinomina una conversazione
• DELETE/api/public/chats/:idElimina una conversazione

Discovery#

Identità, modelli, strumenti e mappa delle capacità a runtime.

• GET/api/public/meA chi appartiene la chiave
• GET/api/public/modelsModelli AI disponibili
• GET/api/public/toolsCatalogo degli strumenti integrati
• GET/api/public/capabilitiesMappa completa delle capacità

App esterne#

Apri la tua applicazione dentro la Box: l’apertura ti consegna una chiave che agisce per conto di chi l’ha aperta.

• POST/api/integrations/embed/exchangeRiscatta un ticket di apertura

Un’integrazione tipica#

Quasi tutti i progetti seguono gli stessi quattro passi.

1. 1. Recupera gli ID. Elenca le cartelle e gli assistenti — oppure creali, se il box è appena partito.
2. 2. Carica i documenti. Carica i file in una cartella e aspetta la fine dell’elaborazione.
3. 3. Chiedi. Cerca direttamente per avere i passaggi grezzi, oppure invia un messaggio in chat per una risposta scritta con le citazioni.
4. 4. Avvisa qualcuno. Invia una notifica all’app desktop quando il lavoro è finito.