Composition API client

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

Copy
<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.26.0</version>
</dependency>

or to your build.gradle file for Gradle:

Copy

1
implementation 'com.algolia:algoliasearch:4.26.0'

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

Copy

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

To create an instance of the client:

Copy

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

List of methods

Each method makes one request to the Composition API.

client.search	Run a Composition
client.searchForFacetValues	Search for facet values

client.listCompositions	List compositions
client.getComposition	Retrieve a composition
client.putComposition	Upsert a composition
client.deleteComposition	Delete a composition
client.multipleBatch	Batch action to multiple compositions

client.getRule	Retrieve a rule
client.putCompositionRule	Upsert a composition rule
client.deleteCompositionRule	Delete a Composition Rule
client.saveRules	Create or update or delete composition rules
client.searchCompositionRules	Search for composition rules

Check task status