​

Install

To get started with the Heurist SDK, you need to install it in your project. The SDK is available via npm, simply follow the instructions to set up the SDK and begin interacting with Heurist in no time.

Recommend using pnpm for installation.

npm i heurist

npm i heurist

pnpm add heurist

yarn add heurist

bun add heurist

​

Authentication

The Heurist API requires authentication using an API key. API keys are used to verify your identity when making requests to the API. Keep in mind the following important points:

• Keep your API key secure! Your API key is sensitive information and should not be shared with others. It must never be exposed in client-side code or in any publicly accessible location (e.g., browser code, repositories).
• Secure your key with backend services: It’s recommended to store your API key in a secure location such as environment variables or key management services (KMS) on your backend server.

​

Example Authentication Flow

To authenticate your application, you will need to pass the API key to the Heurist SDK in your code. Here’s how you can set up authentication:

​

Initialization

import Heurist from 'heurist'

const heurist = new Heurist({
  apiKey: process.env['HEURIST_API_KEY'], 
})