🌴API

Mindplug API Key

Mindplug follows a REST API architecture which can be universally used in any language for any application.

Using the raw API ensures the fastest updates for new and existing endpoints. All the endpoints are listed in this documentation and use axios for making the call requests to Mindplug servers.

The documentation architecture:

Setup

API Setup - Base

• Base instance for axios used to interact with text storage and web.

API Setup - PDFs

• Base instance for axios used to interact with PDF files

API Setup - Audio

• Base instance for axios used to interact with audio

Storing Data

Store basic text

• Store basic text content given a string value.

Store PDF files

• To store files, you need a form instance for axios to pass formData.

Store webpage

• Pass in a URL for mindplug to crawl and read.

Query Data

Query - semantic search

• To semantic search on stored data. Seach by meaning of text.

Query by vector ids

• Search specific vectors by their ids

Query by collection

• Returns the recent 10 vectors from a given collection

Delete Data

Delete by vector ids

• Delete specific data based on vector ids

Delete collection

• Delete an entire collection, including all stored vectors within.

Delete Project

• Delete an entire project, including all collections and vectors within.

List Data

List projects

• List all the projects you have on Mindplug

List collections

• List all the collections you have on Mindplug

Smart

Web search

• Returns the top 3 google results from select resources