Build on your box
IntelligenceBox exposes an HTTP API for everything it does: search your documents, run assistants, manage knowledge folders, and push notifications straight into the desktop app. One API key, one base URL, no SDK required.
How the pieces fit#
Four objects cover almost everything you will build with.
Quickstart#
From nothing to a streamed answer in three steps.
- 1
Get an API key
In the desktop app, open Settings → System → API key, enter a label, and generate a key. It starts with
Full authentication guide →key-. - 2
Find your server URL
Your box has its own address, shown in Settings → Device Info. On a local network it looks like
http://192.168.1.100orhttp://intelligencebox.local; with remote access enabled it is anhttps://…intelligencebox.itsubdomain.Every example on this site writes it as
BOX_URL. - 3
Make your first call
Confirm the key works, then send a message. The chat endpoint streams its answer as Server-Sent Events.
# Who am I? — confirms the key and the workspace
curl BOX_URL/api/public/me \
-H "x-api-key: YOUR_API_KEY"
# Ask a question (streams back)
curl -N -X POST BOX_URL/api/ai/chat \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "my-first-chat",
"messages": [{ "role": "user", "content": "Hello!" }],
"boxAddress": "BOX_URL"
}'Prefer the OpenAI SDK?
The box also speaks the OpenAI wire format at/api/v1/chat/completions. Point any OpenAI-compatible client at BOX_URL/api/v1 with your API key and it works unchanged — see the chat reference.Where to go next#
The three pages that answer most first questions.