To ease the integration of Algolia, we built (alongside with the community!) a set of libraries to help you implement Algolia on your website or application.
The entirety of the Algolia ecosystem is built on top of the REST API. While it allows you to accomplish everything search and indexing related, we highly recommend leveraging one of our API clients instead.
You should only utilize our REST API to develop new API clients. Targeting the REST API without an API client cancels our provided SLA terms.
Indexing & Configuration
The dashboard allows you to:
- manage your subscription to the Algolia service and related options
- configure your team members’ access rights
- see analytics data
- manage indices and API keys
Index and key management can also be done programmatically via our API clients.
Our clients include a retry strategy to ensure you are always able to reach Algolia’s servers.
Built on top of our API Clients, framework integrations hook into framework ORMs to help take care of data synchronization out of the box.
Currently, we offer framework integrations for:
For most use-cases, leveraging one of these integrations is the recommended option if you’re already using the respective framework.
Additionally, we have developed a few extensions that help you implement Algolia in the matter of minutes.
As of today, we have official extensions for:
If you are using one of these products, the appropriate extension will most likely be the path of least resistance for adding Algolia to your website. The extension will handle all of the indexing and synchronization, and also provide a solid front-end user experience out of the box.
On mobile platforms (iOS and Android), the API client can be enhanced with offline capabilities thanks to the optional offline mode. The Offline SDK is a “minified” version of our search engine, trimmed down to fit in a ~1MB package that provides all the basic features of Algolia without the need to contact our servers. The SDK will seamlessly switch between online and offline mode depending on the user’s connectivity.
Building a Search User Interface
We’ve created several different libraries that leverage the API clients to provide even higher-level concepts and interactions to the developers. In particular, these libraries help shorten the development time necessary for creating a search user interface. For a deeper dive into the capabilities of these libraries, see our search libraries overview.
The InstantSearch library provides an extensive library of widgets to power your search and build a state-of-the-art instant-search experience. All of the best practices we have learned while implementing search on hundreds of websites are packed into our widgets. InstantSearch is also available in React, VueJS, iOS, and Android flavors.
The Algolia JS Helper is a set of functions and patterns that make it possible to customize search experiences at a deeper level. Working on top of the Algolia JS Client, the JS Helper exposes new interfaces to perform advanced faceting, manage stateful parameters, and subscribe to events.
The autocomplete.js library adds a fast and fully-featured auto-completion menu to your search box displaying results “as you type”.
For certain specific use cases, we have built products to handle indexing tasks such as data synchronization, configuration, and maintenance.
DocSearch is the easiest way to add search to technical documentation.
To get started, fill out the form on the DocSearch website and we’ll respond with the code snippet necessary to integrate your new search into your website. Not only do we handle crawling your documentation pages, we configure and maintain your search experience for you.
Docsearch is provided for free and does not require creating an Algolia account.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.