You're viewing an archived version of our docs. Check out our current documentation →

Run a Composition

Runs a query on a single composition and returns matching results.

Usage

Required ACL: search
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
import 'package:algolia_client_composition/algolia_client_composition.dart';

final client = CompositionClient(
    appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

final response = await client.search(
  compositionID: "foo",
  requestBody: RequestBody(
    params: Params(
      query: "batman",
      injectedItems: {
        'injectedItem1': ExternalInjectedItem(
          items: [
            ExternalInjection(
              objectID: "my-object-1",
            ),
            ExternalInjection(
              objectID: "my-object-2",
              metadata: {
                'my-string': "string",
                'my-bool': true,
                'my-number': 42,
                'my-object': {
                  'sub-key': 'sub-value',
                },
              },
            ),
          ],
        ),
      },
    ),
  ),
);