The BrainBox API: take your documents to any system
What you can build with the BrainBox API, how to create a key and how to make your first call, with a real sample intranet.
Lesson 1 of 5 · 2:10
What it covers
The BrainBox API connects your systems to your Boxes: you sync documents from the ERP, bring in meeting recordings, search from your intranet and audit access. In this lesson you create a key, make your first call and meet Celtara Hub, the sample app of the whole track.
Frequently asked questions
›What can I do with the BrainBox API?
Create Boxes, upload and index files (also by URL, up to 2 GB), organize folders, move to trash, search by meaning, fetch whole documents, generate temporary links and manage access.
›How do I authenticate?
With a workspace API key in the Authorization: Bearer header. You create the key in API Keys and it's shown only once.
›Can workspace keys see my personal Boxes?
No. A workspace key is limited to that workspace.
Transcript
0:00Many systems
Julián, from IT, has the company spread across systems: the ERP, the intranet, video calls. Can everything connect to BrainBox? Yes, with the API. And in this track we're going to build an app that does it.
0:16What you can build
This is what you're going to build. ERP documents that upload on their own to their folder. Meeting recordings that arrive on their own and get transcribed. A search for your intranet, that finds by meaning. And an audit of who accesses each Box.
0:34Your key
It all starts with a key. In the workspace, in API Keys, click Create API Key. Give it a name that says which system uses it. By default it expires in a year. Create. The key is shown only once. Keep it like a password: in your server's environment variables, never in the code or the browser.
0:57The first call
A ten-line function serves you for the whole track. Every call carries the key in the Authorization header. You test the connection, and ask for your Boxes. The response: each Box with its files and your role. And listing doesn't use any units.
1:15Celtara Hub
This is Celtara Hub, the intranet we'll use for the whole track. Test the connection, and on the right you see every API call, with its response and its time. And here are Celtara's Boxes, read from the API.
1:31The reference
Everything is in the API reference. Boxes, files, folders, trash, search and access. And every endpoint tells you its parameters, its limits and how many units it uses.
1:47Recap
To recap: you create a workspace key and keep it on the server, every call carries it in the header, and from your systems you handle Boxes, files, search and access. Julián knows where to start. Your documents, where you already work.