API & SDKsGraphsCommunities

Create a new community

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

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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