Cosa puoi fare

Discovery#

Scopri a chi appartiene una chiave e cosa il box sa davvero fare in questo momento — inclusi quali modelli AI hanno credenziali configurate.

• GET/healthStato del server
• GET/api/public/meIdentità e workspace dietro la credenziale
• GET/api/public/modelsModelli AI disponibili e stato delle credenziali
• GET/api/public/toolsStrumenti integrati usabili da un assistente
• GET/api/public/capabilitiesVersione machine-readable di questa pagina

App esterne#

Fai vivere la tua applicazione dentro IntelligenceBox. Si apre dal menu con l’identità di chi la usa, e l’apertura le consegna una chiave API che agisce per suo conto — con la sua visibilità, non con un accesso amministrativo.

• POST/api/integrations/embed/exchangeRiscatta un ticket di apertura: identità

Notifiche#

Raggiungi una persona alla sua scrivania. Una notifica viene salvata prima di essere consegnata, quindi sopravvive all’app chiusa e ricompare nella campanella al riavvio.

• 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 una notifica

Cartelle#

Raccolte di conoscenza. Una cartella contiene documenti più le impostazioni di pipeline che decidono come vengono letti, divisi in passaggi e indicizzati.

• GET/api/public/vectorsElenca le cartelle
• POST/api/public/vectorsCrea una cartella
• GET/api/public/vectors/:idLeggi una cartella con le sue impostazioni
• PATCH/api/public/vectors/:idAggiorna una cartella
• DELETE/api/public/vectors/:idElimina una cartella e tutto il suo contenuto

File#

Documenti dentro una cartella. Il caricamento risponde subito e l’elaborazione prosegue in background; lo stato del file dice quando diventa ricercabile.

• GET/api/public/vectors/:id/filesElenca i file
• POST/api/public/vectors/:id/filesCarica un file (multipart)
• GET/api/public/vectors/:id/files/:fileIdLeggi i metadati di un 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#

Solo recupero, senza LLM nel mezzo. Restituisce i passaggi che corrispondono con documento e pagina di origine — il mattone per costruirci il tuo RAG.

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

Assistenti#

Configurazioni AI riutilizzabili: un prompt di sistema, le cartelle consultabili e gli strumenti richiamabili. Un assistente creato qui compare subito nell’app desktop.

• 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, con le citazioni ai documenti da cui provengono.

• POST/api/ai/chatInvia un messaggio e ricevi la risposta in streaming
• POST/api/ai/chat/:id/stopInterrompi una risposta in corso
• POST/api/v1/chat/completionsCompletions compatibili OpenAI
• GET/api/v1/modelsElenco modelli compatibile OpenAI

Conversazioni#

Tutto quello che il box ricorda delle chat passate — comprese quelle arrivate dall’API invece che da una persona nell’app.

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

Scoprirlo a runtime#

La stessa mappa, in JSON, dal tuo box.

curl BOX_URL/api/public/capabilities \
  -H "x-api-key: YOUR_API_KEY"

{
  "version": 1,
  "authentication": {
    "header": "x-api-key",
    "alternative": "Authorization: Bearer <key>",
    "workspaceHeaders": ["x-organization-id", "x-organization-scope"]
  },
  "capabilities": [
    {
      "group": "Notifications",
      "description": "Push notifications into the IntelligenceBox desktop app.",
      "endpoints": [
        { "method": "POST", "path": "/api/public/notifications", "summary": "Send a notification" }
      ]
    }
  ]
}