Skip to main content

Installation

NPM / Yarn / PNPM​

Install the SDK using your preferred package manager:

npm install @seekora-ai/search-sdk

Dependencies​

The SDK has the following dependencies:

DependencyVersionRequired
axios^1.6.0Yes
winston^3.11.0No (for advanced logging)

Browser (CDN)​

For browser usage without a build step, you can use the CDN bundle:

<script src="https://cdn.seekora.ai/sdk/seekora-sdk.min.js"></script>
<script>
  const { SeekoraClient } = window.SeekoraSDK;
  
  const client = new SeekoraClient({
    storeId: 'your-store-id',
    readSecret: 'your-read-secret',
    environment: 'production',  // optional: defaults to 'stage' if omitted
  });
</script>

CDN Bundle Sizes​

BuildSize
Development~646 KB (with source maps)
Production~67 KB (minified)

TypeScript Support​

The SDK is written in TypeScript and includes full type definitions. No additional @types packages are required.

import { SeekoraClient, SearchOptions, SearchResponse } from '@seekora-ai/search-sdk';

Requirements​

  • Node.js: 14.x or higher
  • TypeScript: 4.7+ (if using TypeScript)
  • Browsers: Modern browsers (Chrome, Firefox, Safari, Edge)

Next Steps​

After installation, proceed to Quick Start to configure and use the SDK.