Composition API client

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

Copy
implementation("com.algolia:algoliasearch-client-kotlin:3.29.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:

Copy

1
2
3
4
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:

Copy

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

List of methods

Each method makes one request to the Composition API.

Search

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

Compositions

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

Composition Rules

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

Advanced

client.getTask