Algolia for JavaScript

The perfect starting point to integrate Algolia within your JavaScript project

NPM version NPM downloads jsDelivr Downloads License

DocumentationInstantSearchCommunity ForumStack OverflowReport a bugFAQSupport

## ✨ Features - Thin & **minimal low-level HTTP client** to interact with Algolia's API - Works both on the **browser** and **node.js** - **UMD and ESM compatible**, you can use it with any module loader - Built with TypeScript ## 💡 Getting Started > [!TIP] > This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/ingestion` if you already have `algoliasearch` installed. To get started, you first need to install @algolia/ingestion (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. ### With a package manager ```bash yarn add @algolia/ingestion@1.20.3 # or npm install @algolia/ingestion@1.20.3 # or pnpm add @algolia/ingestion@1.20.3 ``` ### Without a package manager Add the following JavaScript snippet to the of your website: ```html ``` ### Usage You can now import the Algolia API client in your project and play with it. ```js import { ingestionClient } from '@algolia/ingestion'; const client = ingestionClient('YOUR_APP_ID', 'YOUR_API_KEY'); ``` For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/ingestion/)**. ## ❓ Troubleshooting Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md) ## 📄 License The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).