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

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

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

1
2
3
4
import com.algolia.client.api.SearchClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*
import com.algolia.client.extensions.*

To create an instance of the client:

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

List of methods

Each method makes one request to the Search API. The Search API client also includes helper methods that wrap one or more of these methods. For more information, see Helper methods.

Records

Indices

Synonyms

API keys

Rules

Dictionaries

Clusters

Vaults

Advanced

Did you find this page helpful?
Kotlin API clients v3