If you were looking for the API documentation, simply move over to →
https://api.expert.respeak.io/redoc
<aside> 💡
The API description is meant as a user-friendly description of the endpoints that our API provides. You can expect a “quickstart” guide, rather than a deep dive into all the individual aspects of the API.
The API is designed as a way to programmatically use functions that our frontend provides and was not designed as API-first. Thus, some requests and params will not be optimized for easy API-only usage.
</aside>
Welcome to the Respeak Expert Platform API Description!
The Expert Platform empowers its users to chat with their knowledge - essentially removing search effort and helping them get answers from their data in seconds. Knowledge can be anything from documents, website, or data pulled from the connectors we support.
This experience is powered by our custom RAG-pipeline. The pipeline processes data by constructing small units - knowledge pieces and storing them in a vector space. When a user query comes in, we process the query, use various retrieval strategies, pick relevant knowledge pieces, and finally construct a response with an LLM.
The API provides all the functionalities from our platform (available at https://expert.respeak.io) as API endpoints. Essentially, this gets you a managed RAG service to use with your data and for your specific use cases.
How to get started with your first requests and a basic use case scenario
Respeak Expert Platform Account: Sign up for an Expert Platform account if your haven’t already.
(Recommended) Familiarize yourself with the
(Optional) A tool to perform requests against an API backend, such as Postman. Alternatively, you can use your own backend.