PulsejetDB provides REST API endpoints for testing and trying purposes.

REST API isn’t meant for performance oriented use cases.

This section introduces REST API endpoints provided by PulsejetDB to operate on vectors.

Follow these steps to get started:

1

Set up the development environment

Learn more about installation here.

2

Connect to a local or remote instance.

Connect your Pulsejet Instance via local or remote.
Use Async or Sync client to connect to your database.
Please check the client documentation.

3

Insert & Search everything

You can search concurrently at the same time for multiple collections and multiple different indexes to harmonize your output. Take a look at the possible Search Operations to find the most suitable approach for you.

​
Operation Endpoints

Collection Operation Endpoints

View the OpenAPI specification file

Embed Operation Endpoints

View the OpenAPI specification file

Search Operation Endpoints

View the OpenAPI specification file

The REST API endpoints can be used with PulsejetDB running locally at http://127.0.0.1:47044.

​
Authentication

Currently, PulsejetDB doesn’t have any authentication mechanism for its API.

Was this page helpful?

Create Collection