> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulsejet.jetengine.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> REST API documentation for PulsejetDB

PulsejetDB provides REST API endpoints for **testing** and **trying** purposes.

<Warning>REST API isn't meant for performance oriented use cases.</Warning>

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

Follow these steps to get started:

<Steps>
  <Step title="Set up the development environment">
    Learn more about [installation here](/setup/self-hosted).
  </Step>

  <Step title="Connect to a local or remote instance.">
    Connect your Pulsejet Instance via [local](/devel/client) or [remote](/setup/self-hosted/docker).<br />
    Use `Async` or `Sync` client to connect to your database.<br />
    Please check the [client documentation](/devel/client).
  </Step>

  <Step title="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](/api-reference/search) to find the most suitable approach for you.
  </Step>
</Steps>

## Operation Endpoints

<Card title="Collection Operation Endpoints" icon="rectangle-history" href="https://raw.githubusercontent.com/Jet-Engine/publicdocs/main/apicol/openapi.yml">
  View the OpenAPI specification file
</Card>

<Card title="Embed Operation Endpoints" icon="arrows-to-circle" href="https://raw.githubusercontent.com/Jet-Engine/publicdocs/main/apicol/openapi.yml">
  View the OpenAPI specification file
</Card>

<Card title="Search Operation Endpoints" icon="magnifying-glass-waveform" href="https://raw.githubusercontent.com/Jet-Engine/publicdocs/main/apicol/openapi.yml">
  View the OpenAPI specification file
</Card>

<Note>
  The REST API endpoints can be used with PulsejetDB running locally at [http://127.0.0.1:47044](http://127.0.0.1:47044).
</Note>

## Authentication

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