Composition API client

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

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

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

1
2
import algoliasearch.api.CompositionClient
import algoliasearch.config.*

To create an instance of the client:

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