Composition API client

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

Copy

1
npm install @algolia/composition

To use it, run:

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

const client = 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