Cortex API

Communities

Endpoint

Community detection and summarization

List communities

GET

http://localhost:8000

/api/graph/communities

List communities › query Parameters

collection_id

string

List communities › Responses

200

Communities retrieved

object[]

total

integer

GET/api/graph/communities

curl --request GET \
  --url http://localhost:8000/api/graph/communities

shell

Example Responses

{
  "communities": [
    {
      "id": 0,
      "name": "name",
      "summary": "summary",
      "entity_count": 0
    }
  ],
  "total": 0
}

json

application/json

Delete ALL communities

DELETE

http://localhost:8000

/api/graph/communities

Deletes all communities and unlinks their member entities. Entities are preserved.

Delete ALL communities › Responses

200

All communities deleted

communities_deleted

integer

entities_unlinked

integer

DELETE/api/graph/communities

curl --request DELETE \
  --url http://localhost:8000/api/graph/communities

shell

Example Responses

{
  "communities_deleted": 0,
  "entities_unlinked": 0
}

json

application/json

Detect communities

POST

http://localhost:8000

/api/graph/communities/detect

Run community detection algorithm

Detect communities › query Parameters

min_size

integer

Default: 3

collection_id

string

Detect communities › Responses

200

Detection completed

communities_detected

integer

entities_clustered

integer

POST/api/graph/communities/detect

curl --request POST \
  --url http://localhost:8000/api/graph/communities/detect

shell

Example Responses

{
  "communities_detected": 0,
  "entities_clustered": 0
}

json

application/json

Get community details

GET

http://localhost:8000

/api/graph/communities/{community_id}

Get community details › path Parameters

community_id

integer · required

Get community details › Responses

200

Community retrieved

id

integer

name

string

summary

string

object[]

GET/api/graph/communities/{community_id}

curl --request GET \
  --url http://localhost:8000/api/graph/communities/:community_id

shell

Example Responses

{
  "id": 0,
  "name": "name",
  "summary": "summary",
  "entities": [
    {}
  ],
  "relationships": [
    {}
  ]
}

json

application/json

Delete a specific community

DELETE

http://localhost:8000

/api/graph/communities/{community_id}

Deletes the community and unlinks its member entities. Entities are preserved.

Delete a specific community › path Parameters

community_id

integer · required

Delete a specific community › Responses

Community deleted

deleted

boolean

community_id

integer

entities_unlinked

integer

DELETE/api/graph/communities/{community_id}

curl --request DELETE \
  --url http://localhost:8000/api/graph/communities/:community_id

shell

Example Responses

{
  "deleted": true,
  "community_id": 0,
  "entities_unlinked": 0
}

json

application/json

Generate community summaries

POST

http://localhost:8000

/api/graph/communities/summarize

Generate community summaries › Request Body

force_regenerate

boolean

Default: false

collection_id

string

Generate community summaries › Responses

200

Summaries generated

summaries_generated

integer

summaries_skipped

integer

POST/api/graph/communities/summarize

curl --request POST \
  --url http://localhost:8000/api/graph/communities/summarize \
  --header 'Content-Type: application/json' \
  --data '
{
  "force_regenerate": true,
  "collection_id": "collection_id"
}
'

shell

Example Request Body

{
  "force_regenerate": true,
  "collection_id": "collection_id"
}

json

Example Responses

{
  "summaries_generated": 0,
  "summaries_skipped": 0
}

json

application/json

Search communities

GET

http://localhost:8000

/api/graph/communities/search

Search communities › query Parameters

query

string · required

Search communities › Responses

200

Communities found

object[]

total

integer

GET/api/graph/communities/search

curl --request GET \
  --url 'http://localhost:8000/api/graph/communities/search?query=%3Cstring%3E'

shell

Example Responses

{
  "communities": [
    {
      "id": 0,
      "name": "name",
      "summary": "summary",
      "entity_count": 0
    }
  ],
  "total": 0
}

json

application/json

Collections Tasks

Cortex API

Communities

Endpoint

Community detection and summarization

List communities

GET

http://localhost:8000

/api/graph/communities

List communities › query Parameters

collection_id

string

List communities › Responses

200

Communities retrieved

object[]

total

integer

GET/api/graph/communities

curl --request GET \
  --url http://localhost:8000/api/graph/communities

shell

Example Responses

{
  "communities": [
    {
      "id": 0,
      "name": "name",
      "summary": "summary",
      "entity_count": 0
    }
  ],
  "total": 0
}

json

application/json

Delete ALL communities

DELETE

http://localhost:8000

/api/graph/communities

Deletes all communities and unlinks their member entities. Entities are preserved.

Delete ALL communities › Responses

200

All communities deleted

communities_deleted

integer

entities_unlinked

integer

DELETE/api/graph/communities

curl --request DELETE \
  --url http://localhost:8000/api/graph/communities

shell

Example Responses

{
  "communities_deleted": 0,
  "entities_unlinked": 0
}

json

application/json

Detect communities

POST

http://localhost:8000

/api/graph/communities/detect

Run community detection algorithm

Detect communities › query Parameters

min_size

integer

Default: 3

collection_id

string

Detect communities › Responses

200

Detection completed

communities_detected

integer

entities_clustered

integer

POST/api/graph/communities/detect

curl --request POST \
  --url http://localhost:8000/api/graph/communities/detect

shell

Example Responses

{
  "communities_detected": 0,
  "entities_clustered": 0
}

json

application/json

Get community details

GET

http://localhost:8000

/api/graph/communities/{community_id}

Get community details › path Parameters

community_id

integer · required

Get community details › Responses

200

Community retrieved

id

integer

name

string

summary

string

object[]

GET/api/graph/communities/{community_id}

curl --request GET \
  --url http://localhost:8000/api/graph/communities/:community_id

shell

Example Responses

{
  "id": 0,
  "name": "name",
  "summary": "summary",
  "entities": [
    {}
  ],
  "relationships": [
    {}
  ]
}

json

application/json

Delete a specific community

DELETE

http://localhost:8000

/api/graph/communities/{community_id}

Deletes the community and unlinks its member entities. Entities are preserved.

Delete a specific community › path Parameters

community_id

integer · required

Delete a specific community › Responses

Community deleted

deleted

boolean

community_id

integer

entities_unlinked

integer

DELETE/api/graph/communities/{community_id}

curl --request DELETE \
  --url http://localhost:8000/api/graph/communities/:community_id

shell

Example Responses

{
  "deleted": true,
  "community_id": 0,
  "entities_unlinked": 0
}

json

application/json

Generate community summaries

POST

http://localhost:8000

/api/graph/communities/summarize

Generate community summaries › Request Body

force_regenerate

boolean

Default: false

collection_id

string

Generate community summaries › Responses

200

Summaries generated

summaries_generated

integer

summaries_skipped

integer

POST/api/graph/communities/summarize

curl --request POST \
  --url http://localhost:8000/api/graph/communities/summarize \
  --header 'Content-Type: application/json' \
  --data '
{
  "force_regenerate": true,
  "collection_id": "collection_id"
}
'

shell

Example Request Body

{
  "force_regenerate": true,
  "collection_id": "collection_id"
}

json

Example Responses

{
  "summaries_generated": 0,
  "summaries_skipped": 0
}

json

application/json

Search communities

GET

http://localhost:8000

/api/graph/communities/search

Search communities › query Parameters

query

string · required

Search communities › Responses

200

Communities found

object[]

total

integer

GET/api/graph/communities/search

curl --request GET \
  --url 'http://localhost:8000/api/graph/communities/search?query=%3Cstring%3E'

shell

Example Responses

{
  "communities": [
    {
      "id": 0,
      "name": "name",
      "summary": "summary",
      "entity_count": 0
    }
  ],
  "total": 0
}

json

application/json

Collections Tasks