Create a new community

POST

Creates a new community in the graph.

While communities are typically built automatically via the /graphs/{id}/communities/build endpoint, this endpoint allows you to manually create your own communities.

This can be useful when you want to:

Define custom groupings of entities based on domain knowledge
Add communities that weren’t detected by the automatic process
Create hierarchical organization structures
Tag groups of entities with specific metadata

The created communities will be integrated with any existing automatically detected communities in the graph’s community structure.

Path parameters

collection_idstringRequired

The collection ID corresponding to the graph to create the community in.

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.

namestringRequired

The name of the community

summarystringRequired

A summary of the community

findingslist of stringsOptional

Findings about the community

ratingdoubleOptional>=1<=10

Rating between 1 and 10

rating_explanationstringOptional

Explanation for the rating

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.create_community(
7     collection_id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1",
8     name="My Community",
9     summary="A summary of the community",
10     findings=["Finding 1", "Finding 2"],
11     rating=5,
12     rating_explanation="This is a rating explanation",
13 )

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.create_community(
7	collection_id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1",
8	name="My Community",
9	summary="A summary of the community",
10	findings=["Finding 1", "Finding 2"],
11	rating=5,
12	rating_explanation="This is a rating explanation",
13	)

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	}