Cortex API

Collections

Endpoint

Document collection management

List collections

GET

http://localhost:8000

/api/collections

List collections › Responses

200

Collections retrieved

object[]

GET/api/collections

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

shell

Example Responses

{
  "collections": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create collection

POST

http://localhost:8000

/api/collections

Create collection › Request Body

name

string · required

description

string

Create collection › Responses

200

Collection created

id

string

name

string

description

string

created_at

string · date-time

POST/api/collections

curl --request POST \
  --url http://localhost:8000/api/collections \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get collection details

GET

http://localhost:8000

/api/collections/{collection_id}

Get collection details › path Parameters

collection_id

string · required

Get collection details › Responses

200

Collection retrieved

id

string

name

string

description

string

document_count

integer

entity_count

integer

relationship_count

integer

community_count

integer

created_at

string · date-time

updated_at

string · date-time

GET/api/collections/{collection_id}

curl --request GET \
  --url http://localhost:8000/api/collections/:collection_id

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "document_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "community_count": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update collection name or description

PUT

http://localhost:8000

/api/collections/{collection_id}

Update collection name or description › path Parameters

collection_id

string · required

Update collection name or description › Request Body

name

string

New collection name (1-100 characters)

description

string

New collection description (max 500 characters)

Update collection name or description › Responses

Collection updated

id

string

name

string

description

string

document_count

integer

entity_count

integer

relationship_count

integer

community_count

integer

created_at

string · date-time

updated_at

string · date-time

PUT/api/collections/{collection_id}

curl --request PUT \
  --url http://localhost:8000/api/collections/:collection_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "document_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "community_count": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete collection

DELETE

http://localhost:8000

/api/collections/{collection_id}

Delete collection › path Parameters

collection_id

string · required

Delete collection › Responses

200

Collection deleted

No data returned

DELETE/api/collections/{collection_id}

curl --request DELETE \
  --url http://localhost:8000/api/collections/:collection_id

shell

Example Responses

No example specified for this content type

Add document to collection

POST

http://localhost:8000

/api/collections/{collection_id}/documents/{document_id}

Add document to collection › path Parameters

collection_id

string · required

document_id

string · required

Add document to collection › Responses

200

Document added

No data returned

POST/api/collections/{collection_id}/documents/{document_id}

curl --request POST \
  --url http://localhost:8000/api/collections/:collection_id/documents/:document_id

shell

Example Responses

No example specified for this content type

Get collection entities

GET

http://localhost:8000

/api/collections/{collection_id}/entities

Get collection entities › path Parameters

collection_id

string · required

Get collection entities › Responses

200

Entities retrieved

object[]

total

integer

GET/api/collections/{collection_id}/entities

curl --request GET \
  --url http://localhost:8000/api/collections/:collection_id/entities

shell

Example Responses

{
  "entities": [
    {
      "name": "name",
      "type": "type",
      "description": "description",
      "mention_count": 0
    }
  ],
  "total": 0
}

json

application/json

Knowledge Graph Communities

Cortex API

Collections

Endpoint

Document collection management

List collections

GET

http://localhost:8000

/api/collections

List collections › Responses

200

Collections retrieved

object[]

GET/api/collections

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

shell

Example Responses

{
  "collections": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create collection

POST

http://localhost:8000

/api/collections

Create collection › Request Body

name

string · required

description

string

Create collection › Responses

200

Collection created

id

string

name

string

description

string

created_at

string · date-time

POST/api/collections

curl --request POST \
  --url http://localhost:8000/api/collections \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get collection details

GET

http://localhost:8000

/api/collections/{collection_id}

Get collection details › path Parameters

collection_id

string · required

Get collection details › Responses

200

Collection retrieved

id

string

name

string

description

string

document_count

integer

entity_count

integer

relationship_count

integer

community_count

integer

created_at

string · date-time

updated_at

string · date-time

GET/api/collections/{collection_id}

curl --request GET \
  --url http://localhost:8000/api/collections/:collection_id

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "document_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "community_count": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update collection name or description

PUT

http://localhost:8000

/api/collections/{collection_id}

Update collection name or description › path Parameters

collection_id

string · required

Update collection name or description › Request Body

name

string

New collection name (1-100 characters)

description

string

New collection description (max 500 characters)

Update collection name or description › Responses

Collection updated

id

string

name

string

description

string

document_count

integer

entity_count

integer

relationship_count

integer

community_count

integer

created_at

string · date-time

updated_at

string · date-time

PUT/api/collections/{collection_id}

curl --request PUT \
  --url http://localhost:8000/api/collections/:collection_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "document_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "community_count": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete collection

DELETE

http://localhost:8000

/api/collections/{collection_id}

Delete collection › path Parameters

collection_id

string · required

Delete collection › Responses

200

Collection deleted

No data returned

DELETE/api/collections/{collection_id}

curl --request DELETE \
  --url http://localhost:8000/api/collections/:collection_id

shell

Example Responses

No example specified for this content type

Add document to collection

POST

http://localhost:8000

/api/collections/{collection_id}/documents/{document_id}

Add document to collection › path Parameters

collection_id

string · required

document_id

string · required

Add document to collection › Responses

200

Document added

No data returned

POST/api/collections/{collection_id}/documents/{document_id}

curl --request POST \
  --url http://localhost:8000/api/collections/:collection_id/documents/:document_id

shell

Example Responses

No example specified for this content type

Get collection entities

GET

http://localhost:8000

/api/collections/{collection_id}/entities

Get collection entities › path Parameters

collection_id

string · required

Get collection entities › Responses

200

Entities retrieved

object[]

total

integer

GET/api/collections/{collection_id}/entities

curl --request GET \
  --url http://localhost:8000/api/collections/:collection_id/entities

shell

Example Responses

{
  "entities": [
    {
      "name": "name",
      "type": "type",
      "description": "description",
      "mention_count": 0
    }
  ],
  "total": 0
}

json

application/json

Knowledge Graph Communities