Importing with the API

How to index your data to Algolia using an API client.

Algolia doesn’t directly search your data sources. Instead, you upload the parts of your data that are relevant for search to Algolia. Algolia stores this data in an index: a data structure optimized for fast search.

• For more information about preparing your data for indexing, see Format and structure your data.
• For alternatives to the API for pushing data, see Send your data to Algolia.

Required credentials

To send data to Algolia, you need an Application ID and a valid API key (with addObjects permission). You can find them in the API Keys section of Algolia’s dashboard.

Application ID

Your Application ID is what Algolia uses to identify your app, where all your indices live.

API key

API keys control access to Algolia’s API and determine what you’re allowed to do, such as searching an index, or adding new records. For better security, create specific API keys with minimal permissions for indexing tasks, which you should only use in server-side code. Keep your indexing API keys secret.

Only use the Admin API key to create other API keys. Don’t use the Admin API key in your apps.

Set up the API client

First, you need to install and set up your API client. For installation instructions, go to the API client documentation for your programming language:

• Go
• Java
• JavaScript
• Kotlin
• .NET
• PHP
• Python
• Ruby
• Scala
• Swift

After installing the API client, you can initialize it and connect to Algolia:

Fetch your data

Before sending anything to Algolia, you need to retrieve your data. You can do this in several ways, depending on the nature of your app. Here are potential examples:

From a database

From a file

You can use this actors dataset to test this out.

From the source code directly

Only use this method for exploration purposes or if you have a small amount of data.

Send the data to Algolia

Once the records are ready, you can push them to Algolia using the saveObjects method.

Send your data in batches

For performance reasons, you should send several records at once instead of one by one. If you have many records to index, you should send them in batches.

Once you’re done, you can configure relevance settings.