Search your Boxes from your intranet or your apps with the BrainBox API

How to bring BrainBox search to your own apps: results by meaning, with file and page, and a secure link to the original document.

Lesson 4 of 5 · 1:18

What it covers

With the API, your intranet searches your Boxes by meaning. You type a question, BrainBox returns the most relevant passages with their file and page, and a temporary link opens the original document. So any system can use your knowledge without people opening BrainBox.

Frequently asked questions

›How do I search through the API?

With POST /boxes/{id}/retrieve-documents and the query field. It returns passages with text, file and page, ordered by relevance.

›How do I open the original document?

With GET /files/{id}/signed-url: a 10-minute temporary link to the file.

›Can I fetch whole documents?

Yes, with POST /boxes/{id}/retrieve-full-documents, up to 10 files per call.

Transcript

0:00From the intranet

Andrés wants the team to search the contracts from the intranet, without opening BrainBox. The API brings BrainBox search to any app.

0:10The code

It's two calls. The search takes a question, in natural language. And you keep the main matches; the rest is context around them. Each result has the file, the page and the text. And the link to the original lasts ten minutes: secure, without exposing your files.

0:30In Celtara Hub

In the Hub's search, Andrés types the way he talks: what guarantees does the supplier owe us? Search. The first result comes from the agreement, page three, where the bonds are, and then the technical annex and the amendment. No exact words: by meaning. And Open requests the temporary link to the original document.

0:53Recap

To recap: with retrieve-documents you search by meaning, each result has its file and page, and with signed-url you open the original with a temporary link. Andrés's intranet now knows what the contracts say. Your knowledge, in every app.