Sep 25, 2025
Run a Composition
Runs a query on a single composition and returns matching results.
Usage
Required ACL:
search
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import algoliasearch.api.CompositionClient
import algoliasearch.config.*
val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
val response = Await.result(
client.search(
compositionID = "foo",
requestBody = RequestBody(
params = Some(
Params(
query = Some("batman"),
injectedItems = Some(
Map(
"injectedItem1" -> ExternalInjectedItem(
items = Seq(
ExternalInjection(
objectID = "my-object-1"
),
ExternalInjection(
objectID = "my-object-2",
metadata = Some(
Map(
"my-string" -> "string",
"my-bool" -> true,
"my-number" -> 42,
"my-object" -> JObject(
List(
JField("sub-key", JString("sub-value"))
)
)
)
)
)
)
)
)
)
)
)
)
),
Duration(100, "sec")
)