Initialize

Create an Etoile client instance.


Setup

import { Etoile } from "@etoile-dev/client";

const etoile = new Etoile({
apiKey: process.env.ETOILE_API_KEY,
});

API keys

Etoile uses two types of API keys:

  • Secret key — For indexing, updating, and deleting documents (server-side only)
  • Public key — For search only (safe to use client-side)

Never expose your secret key in client-side code or public repositories.


Options

ParameterTypeDescription
apiKeyrequiredstringYour API key (secret or public).

Next