Update community

POST

Updates an existing community in the graph.

Path parameters

collection_idstringRequired

community_idstringRequired

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.

namestringOptional

summarystringOptional

findingslist of stringsOptional

ratingdoubleOptional>=1<=10

rating_explanationstringOptional

Response

Successful Response

resultsobject

Errors

POST

1 from r2r import R2RClient
2 
3 client = R2RClient()
4 # when using auth, do client.login(...)
5 
6 response = client.graphs.update_community(
7     collection_id="d09dedb1-b2ab-48a5-b950-6e1f464d83e7",
8     community_update={
9         "metadata": {
10             "topic": "Technology",
11             "description": "Tech companies and products"
12         }
13     }
14 )

200Successful

1 {
2   "results": {
3     "name": "name",
4     "summary": "summary",
5     "level": 1,
6     "findings": [
7       "findings"
8     ],
9     "id": 1,
10     "community_id": "community_id",
11     "collection_id": "collection_id",
12     "rating": 1.1,
13     "rating_explanation": "rating_explanation",
14     "description_embedding": [
15       1.1
16     ],
17     "attributes": {
18       "key": "value"
19     },
20     "created_at": "2024-01-15T09:30:00Z",
21     "updated_at": "2024-01-15T09:30:00Z"
22   }
23 }

Built with

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	response = client.graphs.update_community(
7	collection_id="d09dedb1-b2ab-48a5-b950-6e1f464d83e7",
8	community_update={
9	"metadata": {
10	"topic": "Technology",
11	"description": "Tech companies and products"
12	}
13	}
14	)

1	{
2	"results": {
3	"name": "name",
4	"summary": "summary",
5	"level": 1,
6	"findings": [
7	"findings"
8	],
9	"id": 1,
10	"community_id": "community_id",
11	"collection_id": "collection_id",
12	"rating": 1.1,
13	"rating_explanation": "rating_explanation",
14	"description_embedding": [
15	1.1
16	],
17	"attributes": {
18	"key": "value"
19	},
20	"created_at": "2024-01-15T09:30:00Z",
21	"updated_at": "2024-01-15T09:30:00Z"
22	}
23	}