Composition API client

Search using the Composition API.

C#

The Composition API client is part of the Algolia.Search package. To install this package, run:

Command line

dotnet add package Algolia.Search

To use the Composition client, import these namespaces:

C#

using Algolia.Search.Clients;
using Algolia.Search.Http;
using Algolia.Search.Models.Composition;

To create an instance of the client:

C#

var client = new CompositionClient(
  new CompositionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);

Dart

The Composition API client is part of the algoliasearch package. To install this package, run:

Command line

dart pub add algoliasearch

To use the Composition client, add this import to your files:

Dart

import 'package:algolia_client_composition/algolia_client_composition.dart';

To create an instance of the client:

Dart

final client = CompositionClient(
    appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

Go

The Composition API client is part of the algoliasearch-client-go package. To install it, run:

Command line

go get github.com/algolia/algoliasearch-client-go

To use the Composition client, add this import to your files:

Go

import "github.com/algolia/algoliasearch-client-go/v4/algolia/composition"

To create an instance of the client:

Go

client, err := composition.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

Java

The Composition API client is part of the algoliasearch package. You can add this package to your pom.xml file for Maven:

pom.xml

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.25.0</version>
</dependency>

or to your build.gradle file for Gradle:

build.gradle

implementation 'com.algolia:algoliasearch:4.25.0'

To use the Composition client, add these imports to your files:

Java

import com.algolia.api.CompositionClient;
import com.algolia.config.*;

To create an instance of the client:

Java

CompositionClient client = new CompositionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

JavaScript

The Composition API client is available as a package of its own: @algolia/composition. To install this package, run:

Command line

npm install @algolia/composition

To use it, run:

JavaScript

import { compositionClient } from "@algolia/composition";

const client = compositionClient(
  "ALGOLIA_APPLICATION_ID",
  "ALGOLIA_API_KEY"
);

Kotlin

The Composition API client is part of the algoliasearch-scala package. You can add this package to your build.gradle.kts file:

build.gradle.kts

implementation("com.algolia:algoliasearch-client-kotlin:3.28.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

To use the Composition client, add this import to your files:

Kotlin

import com.algolia.client.api.CompositionClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*
import com.algolia.client.model.composition.RequestBody

To create an instance of the client:

Kotlin

val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

PHP

The Composition API client is part of the algoliasearch-client-php package. To install this package, run:

Command line

composer require algolia/algoliasearch-client-php

To use the Composition client, add this import to your files:

PHP

use Algolia\AlgoliaSearch\Api\CompositionClient;

To create an instance of the client:

PHP

$client = CompositionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

Python

The Composition API client is part of the algoliasearch package. You can install this package with pip:

Command line

pip install 'algoliasearch>=4,<5'

To use the Composition client, add this import to your files:

Python

from algoliasearch.composition.client import CompositionClientSync

To create an instance of the client:

Python

# In an asynchronous context, you can use CompositionClient instead, which exposes the exact same methods.
client = CompositionClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

Async code

To use the Composition client in async environments, add these imports instead:

Python

import asyncio
from algoliasearch.composition.client import CompositionClient

The client supports the async with statement to automatically close open connections.

Python

async def run():
    async with CompositionClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

Ruby

The Composition API client is part of the algolia gem. To install this gem, run:

Command line

gem install algolia

To use the Composition client, add this import to your files:

Ruby

require "algolia"

To create an instance of the client:

Ruby

client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

Scala

The Composition API client is part of the algoliasearch-scala package. You can add this package to your build.sbt file:

build.sbt

// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.27.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.27.0"

To use the Composition client, add these imports to your files:

Scala

import algoliasearch.api.CompositionClient
import algoliasearch.config.*

To create an instance of the client:

Scala

val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

Swift

The Composition API client is part of the algoliasearch-client-swift package. You can add this package to your Package.swift file:

Package.swift

// swift-tools-version: 5.10
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
  name: "Algolia API clients",
  platforms: [
    .macOS(.v11)
  ],
  dependencies: [
    .package(
      url: "https://github.com/algolia/algoliasearch-client-swift.git", from: "9.28.0")
  ],
  targets: [
    .executableTarget(
      name: "Algolia API clients",
      dependencies: [
        .product(name: "Composition", package: "algoliasearch-client-swift")
      ]
    )
  ]
)

To use the Composition API client, add this import to your files:

Swift

import Composition

To create an instance of the client:

Swift

let client = try CompositionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")