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
require "algolia"
client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
response = client.search(
"foo",
Algolia::Composition::RequestBody.new(
params: Algolia::Composition::Params.new(
query: "batman",
injected_items: {
injectedItem1: Algolia::Composition::ExternalInjectedItem.new(
items: [
Algolia::Composition::ExternalInjection.new(algolia_object_id: "my-object-1"),
Algolia::Composition::ExternalInjection.new(
algolia_object_id: "my-object-2",
metadata: {
:"my-string" => "string",
:"my-bool" => true,
:"my-number" => 42,
:"my-object" => {:"sub-key" => "sub-value"}
}
)
]
)
}
)
)
)