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
import { compositionClient } from '@algolia/composition';

const client = compositionClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

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