Skip to main content

Working via API

InsightStream provides a flexible and convenient API interface for integration with external systems and process automation. The API allows performing all main platform functionality without the need to use a graphical interface: uploading documents, managing bots, and performing intelligent search.

Working with InsightStream API is built by analogy with OpenAI's Assistants API — you create a bot by passing documents and a user story description, then send search queries and receive accurate answers with source references.

The following sections describe in detail three key aspects of working via API:

  • Creating and managing assistants — uploading and indexing documents, adding/updating files, deleting bots and individual documents.
  • Q&A — executing search queries to an already created bot and receiving answers to a specific question.
  • Dialog — conducting a dialog with an already created bot that uses search (RAG) when needed