Guides / Sending and managing data / Send and update your data

Oct. 27, 2021

Importing with the API

Quickstart# A

If you want to get started with the most common indexing operations, explore the quickstart samples on GitHub. These are self-contained code samples that you can run directly from your code editor.

Quickstarts Go API Client Quickstarts

Java API Client Quickstarts

JavaScript API Client Quickstarts

PHP API Client Quickstarts

Python API Client Quickstarts

Ruby API Client Quickstarts

.NET API Client Quickstarts

Required credentials# A

To push data to Algolia, you need an Application ID and a valid API key with the right access level. You can find them in the Algolia dashboard in the API Keys section. These credentials let you connect to Algolia and perform operations on your data.

Application ID#

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

API key#

The Admin API key is the one you need to create, update, and delete records. This is the most sensitive key, as it provides full control of all your indices and data. Make sure to keep it secret and secure, don’t release it to anyone, and only use it in back-end code.

For added security, it’s better not to use your Admin API key directly to handle indices, but generate more restrictive keys from it and use them instead.

Guides API Keys

Setting up the API client# A

First, you need to install and set up your API client. For installation instructions, head over to the installation guide for your language.

Edit

Copy

1
2
3
4
5
6
7
8
9
10
11
12
// composer autoload
require __DIR__ . '/vendor/autoload.php';

// if you are not using composer
// require_once 'path/to/algoliasearch.php';

$client = \Algolia\AlgoliaSearch\SearchClient::create(
  'AJ0P3S7DWQ',
  '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb'
);

$index = $client->initIndex('your_index_name');

1
2
3
4
require 'algolia'

client = Algolia::Search::Client.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')
index = client.init_index('your_index_name')

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// for the default version
const algoliasearch = require('algoliasearch');

// for the default version
import algoliasearch from 'algoliasearch';

// for the search only version
import algoliasearch from 'algoliasearch/lite';

// or just use algoliasearch if you are using a <script> tag
// if you are using AMD module loader, algoliasearch will not be defined in window,
// but in the AMD modules of the page

const client = algoliasearch('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');
const index = client.initIndex('your_index_name');

1
2
3
4
from algoliasearch.search_client import SearchClient

client = SearchClient.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')
index = client.init_index('your_index_name')

1
2
let client = SearchClient(appID: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
let index = client.index(withName: "your_index_name")

1
2
SearchClient client = new SearchClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
SearchIndex index = client.InitIndex("your_index_name");

1
2
3
4
SearchClient client =
DefaultSearchClient.create("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");

SearchIndex index = client.initIndex("your_index_name");

1
2
3
4
5
6
7
8
package main

import "github.com/algolia/algoliasearch-client-go/v3/algolia/search"

func main() {
  client := search.NewClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
  index := client.InitIndex("your_index_name")
}

1
2
3
4
5
6
7
val client = ClientSearch(
    applicationID = ApplicationID("AJ0P3S7DWQ"),
    apiKey = APIKey("••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
)
val indexName = IndexName("your_index_name")

client.initIndex(indexName)

Fetching your data# A

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

From a database#

Edit

Copy

1
2
3
4
5
6
function fetchDataFromDatabase() {
  $actors = // Fetch data from your database
  return $actors;
}

$records = fetchDataFromDatabase();

1
2
3
4
5
6
public IEnumerable<Actor> FetchDataFromDataBase() {
  IEnumerable<Actor> actors = // Fetch data from your database
  return actors;
}

var actors = FetchDataFromDataBase();

1
2
3
4
5
6
public List<Actor> fetchDataFromDatabase() {
  List<Actor> actors = // Fetch data from your database
  return actors;
}

List<Actor> actors = fetchDataFromDataBase();

1
2
3
4
5
6
7
8
func fetchDataFromDatabase() []Actor {
  actors := // Fetch data from your database
  return actors
}

func main() {
  records := fetchDataFromDatabase()
}

1
2
3
4
5
6
7
fun fetchFromDatabase(): List<Actor> {
      val actors: List<Actor> = listOf() // Fetch data from your database

      return actors
  }

  val actors: List<Actor> = fetchFromDatabase()

From a file#

You can use this actors dataset to test this out.

Edit

Copy

1
$records = json_decode(file_get_contents('actors.json'), true);

1
2
3
let filePath = Bundle.main.path(forResource: "actors", ofType: "json")!
let contentData = FileManager.default.contents(atPath: filePath)!
let records = try! JSONSerialization.jsonObject(with: contentData, options: []) as! [[String: Any]]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
using System.IO;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;

public class Actor
{
  public string Name { get; set; }
  public string ObjectID { get; set; }
  public int Rating { get; set; }
  public string ImagePath { get; set; }
  public string AlternativePath { get; set; }
}

SearchClient client = new SearchClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
SearchIndex index = client.InitIndex("actors");

// Don't forget to set the naming strategy of the serializer to handle Pascal/Camel casing
// Or you can set JsonProperty(PropertyName = "")] attribute on each field
var settings = new JsonSerializerSettings
{
  ContractResolver = new DefaultContractResolver
  {
      NamingStrategy = new CamelCaseNamingStrategy()
  }
});

IEnumerable<Actor> actors = JsonConvert.DeserializeObject<IEnumerable<Actor>>(File.ReadAllText("actors.json"), settings);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import java.io.FileInputStream;
import java.io.InputStream;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Actor {
    // Getters/Setters ommitted
    private String name;
    private String objectID;
    private int rating;
    private String imagePath;
    private String alternativePath;
}

ObjectMapper objectMapper = Defaults.getObjectMapper();

InputStream input = new FileInputStream("actors.json");
Actor[] actors = objectMapper.readValue(input, Actor[].class);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package main

import (
  "encoding/json"
  "io/ioutil"
)

type Actor struct {
  Name            string `json:"name"`
  Rating          int    `json:"rating"`
  ImagePath       string `json:"image_path"`
  AlternativeName string `json:"alternative_name"`
  ObjectID        string `json:"objectID"`
}

func main() {
  var actors []Actor
  data, _ := ioutil.ReadFile("actors.json")
  _ = json.Unmarshal(data, &actors)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import org.json4s._
import org.json4s.native.JsonMethods._

case class Actor(name: String,
                 rating: Int,
                 image_path: String,
                 alternative_path: Option[String],
                 objectID: String)

object Main {

  def main(args: Array[String]): Unit = {

    val json = parse(new FileInputStream("actors.json")).extract[Seq[Actor]]

  }

}

1
2
3
4
5
6
7
8
9
10
11
@Serializable
data class Actor(
    val name: String,
    val rating: Int,
    val imagePath: String,
    val alternativePath: String,
    override val objectID: ObjectID
) : Indexable

val string = File("actors.json").readText()
val actors: List<Actors> = Json.plain.parse(Actor.serializer().list, string)

From the source code directly#

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

Edit

Copy

1
2
3
4
$records = [
  ['name' => 'Tom Cruise'],
  ['name' => 'Scarlett Johansson']
];

1
2
3
4
5
6
7
8
9
10
public class Actor
{
  public string Name { get; set; }
}

 var records = new List<Actor>
 {
    new Actor { Name = "Tome Cruise" },
    new Actor { Name = "Scarlett Johansson" }
 };

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class Person {

   private String name;

   public Person() {}

   public String getName() {
     return name;
   }

   public Person setName(String name) {
     this.name = name;
     return this;
   }
 }

 ArrayList<Person> persons = new ArrayList<Person>() {{
    add(new Person().setName("Tom Cruise"));
    add(new Person().setName("Scarlett Johansson"));
 }};

Send the data to Algolia# A

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

Edit

Copy

1
$index->saveObjects($records, ['autoGenerateObjectIDIfNotExist' => true]);

Batching your records#

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, don’t forget to configure relevance settings.

Did you find this page helpful?

Importing with the API

On this page

Quickstart# A

Required credentials# A

Application ID#

API key#

Setting up the API client# A

Fetching your data# A

From a database#

From a file#

From the source code directly#

Send the data to Algolia# A

Batching your records#

On this page

Importing with the API

On this page

Quickstart# Found an issue? Edit this guide A Edit this guide

Required credentials# Found an issue? Edit this guide A Edit this guide

Application ID#

API key#

Setting up the API client# Found an issue? Edit this guide A Edit this guide

Fetching your data# Found an issue? Edit this guide A Edit this guide

From a database#

From a file#

From the source code directly#

Send the data to Algolia# Found an issue? Edit this guide A Edit this guide

Batching your records#

On this page

Quickstart# A

Required credentials# A

Setting up the API client# A

Fetching your data# A

Send the data to Algolia# A