API Reference

We now offer three main endpoints: collections, agents and chat.

Collections are groups of documents or URLs that OpenIndex.ai will index and embed.

You can then refer to the collection via a collectionId parameter when using the /chat endpoint.

Agents are chat bots with memory about previous conversations. Each agent can be created with a default large language model (LLM) (see supported models), model parameters like temperature, topK, topP, frequencyPenalty, repetitionPenalty and tools (plugins).

The Chat endpoint can be used to retrieve a user's chats and chat with collections and agents. Our backend will take care of persisting the context of the current conversation.

We also have Postman documentation available.