Sep 25, 2025
Upsert a composition
Upsert a composition in the current Algolia application.
Usage
Required ACL:
editSettings
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
45
46
47
48
49
50
51
52
import { compositionClient } from '@algolia/composition';
const client = compositionClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
const response = await client.putComposition({
compositionID: 'my-metadata-compo',
composition: {
objectID: 'my-metadata-compo',
name: 'my composition',
behavior: {
injection: {
main: { source: { search: { index: 'foo', params: { filters: 'brand:adidas' } } } },
injectedItems: [
{
key: 'injectedItem1',
source: { search: { index: 'foo', params: { filters: 'brand:adidas' } } },
position: 2,
length: 1,
metadata: {
hits: {
addItemKey: true,
extra: {
'my-string': 'string',
'my-bool': true,
'my-number': 42,
'my-object': { 'sub-key': 'sub-value' },
},
},
},
},
{
key: 'externalItem',
source: { search: { index: 'foo', params: { filters: 'brand:puma' } } },
position: 5,
length: 5,
metadata: {
hits: {
addItemKey: true,
extra: {
'my-string': 'string',
'my-bool': true,
'my-number': 42,
'my-object': { 'sub-key': 'sub-value' },
},
},
},
},
],
},
},
},
});