API Endpoints

All endpoints use your IntelligenceBox server URL. Replace BOX_URL with your actual URL (found in SettingsDevice Info).

Authentication

Add your API key to every request:

x-api-key: YOUR_API_KEY
# or
Authorization: Bearer YOUR_API_KEY

Endpoints

EndpointMethodAuthDescription
/healthGETNoCheck server status
/api/public/vectorsGETYesList all folders
/api/public/vectors/:idGETYesGet folder by ID
/api/public/vectors/:id/filesPOSTYesUpload a file into a folder
/api/public/vectors/:id/filesGETYesList files in a folder
/api/public/vectors/:id/files/:fileIdGET / PUT / DELETEYesGet, replace, or delete a file
/api/public/vectors/:id/files/:fileId/contentGETYesDownload a file
/api/public/assistantsGETYesList all assistants
/api/public/assistants/:idGETYesGet assistant by ID
/api/ai/chatPOSTYesSend chat message
/api/ai/chat/:id/stopPOSTYesStop response

Workflow

  1. Get IDs first - Call List Folders and List Assistants to get the UUIDs you need
  2. Upload documents (optional) - Upload files into a folder so the AI can search them
  3. Send chat - Use the IDs in your Chat requests
  4. Parse response - Handle the streaming SSE response

Quick Test

# Health check (no auth)
curl BOX_URL/health

# List folders (with auth)
curl BOX_URL/api/public/vectors \
  -H "x-api-key: YOUR_API_KEY"
API Endpoints | IntelligenceBox