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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
---
title: 'Managing Connection Resources'
sidebarTitle: 'Managing Resources'
description: 'Get and configure resources for connections that support resource management'
icon: 'folder-sync'
---
<Note>
**Currently Available for GitHub:** Resource management endpoints are currently only available for the GitHub connector. These endpoints allow you to select which repositories to sync before syncing begins.
</Note>
Some connectors require you to select which resources (e.g., repositories) to sync before syncing begins. Use these generic endpoints to list and configure resources for connections that support resource management.
## Get Resources
`GET /v3/connections/:connectionId/resources`
Get available resources (e.g., repositories, folders) for a connection using stored credentials.
<CodeGroup>
```typescript Typescript
import Supermemory from 'supermemory';
const client = new Supermemory({
apiKey: process.env['SUPERMEMORY_API_KEY'],
});
// Get resources with pagination
const response = await fetch(
`https://api.supermemory.ai/v3/connections/${connectionId}/resources?page=1&per_page=30`,
{
headers: {
'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
},
}
);
const data = await response.json();
console.log('Resources:', data.resources);
console.log('Total count:', data.total_count);
```
```python Python
import requests
url = f"https://api.supermemory.ai/v3/connections/{connection_id}/resources"
params = {
"page": 1,
"per_page": 30
}
headers = {
"Authorization": f"Bearer {api_key}",
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
print(f"Resources: {data['resources']}")
print(f"Total count: {data.get('total_count')}")
```
```bash cURL
curl -X GET \
"https://api.supermemory.ai/v3/connections/{connectionId}/resources?page=1&per_page=30" \
-H "Authorization: Bearer <token>"
```
</CodeGroup>
### Query Parameters
- `page`: Optional. Page number for pagination. Default: `1`
- `per_page`: Optional. Number of resources per page. Default: `30`
### Response
```json
{
"resources": [
{
"id": 123456789,
"name": "your-org/documentation",
"full_name": "your-org/documentation",
"description": "Documentation repository",
"private": false,
"default_branch": "main",
"updated_at": "2024-01-15T10:00:00Z"
}
],
"total_count": 45
}
```
### Error Responses
- `400`: Connection missing refresh token
- `401`: Unauthorized
- `404`: Connection not found
- `501`: Provider does not support resource fetching
<Note>
**Provider Support:** Not all providers support resource fetching. This endpoint is only available for providers that implement the `fetchResources()` method (e.g., GitHub). For providers that don't support this, you'll receive a `501 Not Implemented` response.
</Note>
## Configure Connection
`POST /v3/connections/:connectionId/configure`
Configure selected resources (e.g., repositories) for a connection and set up webhooks/subscriptions.
<CodeGroup>
```typescript Typescript
import Supermemory from 'supermemory';
const client = new Supermemory({
apiKey: process.env['SUPERMEMORY_API_KEY'],
});
// Configure connection
const response = await fetch(
`https://api.supermemory.ai/v3/connections/${connectionId}/configure`,
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
resources: [
{
id: 123456789,
name: 'your-org/documentation',
defaultBranch: 'main',
},
{
id: 987654321,
name: 'your-org/api-docs',
defaultBranch: 'main',
},
],
}),
}
);
const data = await response.json();
console.log('Success:', data.success);
console.log('Message:', data.message);
console.log('Webhooks registered:', data.webhooksRegistered);
```
```python Python
import requests
url = f"https://api.supermemory.ai/v3/connections/{connection_id}/configure"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
}
payload = {
"resources": [
{
"id": 123456789,
"name": "your-org/documentation",
"defaultBranch": "main",
},
{
"id": 987654321,
"name": "your-org/api-docs",
"defaultBranch": "main",
},
]
}
response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(f"Success: {data['success']}")
print(f"Message: {data['message']}")
print(f"Webhooks registered: {data.get('webhooksRegistered')}")
```
```bash cURL
curl -X POST \
"https://api.supermemory.ai/v3/connections/{connectionId}/configure" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"resources": [
{
"id": 123456789,
"name": "your-org/documentation",
"defaultBranch": "main"
},
{
"id": 987654321,
"name": "your-org/api-docs",
"defaultBranch": "main"
}
]
}'
```
</CodeGroup>
### Request Body
```json
{
"resources": [
{
"id": 123456789,
"name": "your-org/documentation",
"defaultBranch": "main"
}
]
}
```
The structure of each resource object depends on the provider. For GitHub, resources include:
- `id`: Repository ID (number)
- `name`: Repository full name (string)
- `defaultBranch`: Default branch name (string)
### Response
```json
{
"success": true,
"message": "Resources configured successfully",
"webhooksRegistered": 2
}
```
### Error Responses
- `400`: Connection missing refresh token
- `401`: Unauthorized
- `404`: Connection not found
- `501`: Provider does not support resource configuration
<Note>
**Automatic Sync:** After successfully configuring resources, an initial sync is automatically triggered for the connection. You don't need to manually trigger a sync after configuration.
</Note>
<Warning>
**Provider Support:** Not all providers support resource configuration. This endpoint is only available for providers that implement the `configureConnection()` method (e.g., GitHub). For providers that don't support this, you'll receive a `501 Not Implemented` response.
</Warning>
## Example: GitHub Repository Selection
Here's a complete example for GitHub:
<CodeGroup>
```typescript Typescript
// 1. Create connection (see creating-connection.mdx)
const connection = await client.connections.create('github', {
redirectUrl: 'https://yourapp.com/callback',
});
// 2. After OAuth callback, fetch available repositories
const resourcesResponse = await fetch(
`https://api.supermemory.ai/v3/connections/${connection.id}/resources?page=1&per_page=100`,
{
headers: {
'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
},
}
);
const { resources } = await resourcesResponse.json();
// 3. Display repositories to user and let them select
// (Build your UI here)
// 4. Configure selected repositories
const configureResponse = await fetch(
`https://api.supermemory.ai/v3/connections/${connection.id}/configure`,
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
resources: selectedRepositories, // User's selection
}),
}
);
const result = await configureResponse.json();
console.log('Sync initiated:', result.success);
```
```python Python
# 1. Create connection (see creating-connection.mdx)
connection = client.connections.create(
'github',
redirect_url='https://yourapp.com/callback'
)
# 2. After OAuth callback, fetch available repositories
resources_response = requests.get(
f"https://api.supermemory.ai/v3/connections/{connection.id}/resources",
params={"page": 1, "per_page": 100},
headers={"Authorization": f"Bearer {api_key}"}
)
resources = resources_response.json()["resources"]
# 3. Display repositories to user and let them select
# (Build your UI here)
# 4. Configure selected repositories
configure_response = requests.post(
f"https://api.supermemory.ai/v3/connections/{connection.id}/configure",
json={"resources": selected_repositories}, # User's selection
headers={"Authorization": f"Bearer {api_key}"}
)
result = configure_response.json()
print(f"Sync initiated: {result['success']}")
```
```bash cURL
# 1. Create connection (see creating-connection.mdx)
# ... (OAuth flow) ...
# 2. Fetch available repositories
curl -X GET \
"https://api.supermemory.ai/v3/connections/{connectionId}/resources?page=1&per_page=100" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY"
# 3. Configure selected repositories
curl -X POST \
"https://api.supermemory.ai/v3/connections/{connectionId}/configure" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"resources": [
{
"id": 123456789,
"name": "your-org/documentation",
"defaultBranch": "main"
}
]
}'
```
</CodeGroup>
|