Cortex API

Health

Endpoint

Health check and statistics

Health check

GET

http://localhost:8000

/health

Check if the API is healthy and connected to Neo4j

Health check › Responses

200

API is healthy

status

string

neo4j

string

version

string

GET/health

curl --request GET \
  --url http://localhost:8000/health

shell

Example Responses

{
  "status": "healthy",
  "neo4j": "connected",
  "version": "1.0.0"
}

json

application/json

Get knowledge base statistics

GET

http://localhost:8000

/api/stats

Returns counts of documents, chunks, entities, and relationships

Get knowledge base statistics › Responses

200

Statistics retrieved

document_count

integer

chunk_count

integer

entity_count

integer

relationship_count

integer

per_chunk_relationship_count

integer

Relations discovered in Step 1 (per-chunk extraction)

collection_count

integer

GET/api/stats

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

shell

Example Responses

{
  "document_count": 0,
  "chunk_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "per_chunk_relationship_count": 0,
  "collection_count": 0
}

json

application/json

Prometheus metrics

GET

http://localhost:8000

/metrics

Prometheus exposition-format metrics. Admin-only and not routed through the production nginx. Returns 404 when metrics are disabled and 501 when prometheus-client is not installed in the image.

Prometheus metrics › Responses

Metrics in Prometheus text exposition format

string

Get UI feature flags

GET

http://localhost:8000

/api/features

Lightweight, non-admin feature flags for gating UI features (Collections, Skills, Git integration, Web import) without exposing the full system configuration. Requires read permission.

Get UI feature flags › Responses

200

Feature flags

enable_collections

boolean

enable_skills

boolean

enable_git_integration

boolean

enable_web_crawl

boolean

True only when the master switch is on AND a crawl service is configured

GET/api/features

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

shell

Example Responses

{
  "enable_collections": true,
  "enable_skills": true,
  "enable_git_integration": true,
  "enable_web_crawl": true
}

json

application/json

Documents

Cortex API

Health

Endpoint

Health check and statistics

Health check

GET

http://localhost:8000

/health

Check if the API is healthy and connected to Neo4j

Health check › Responses

200

API is healthy

status

string

neo4j

string

version

string

GET/health

curl --request GET \
  --url http://localhost:8000/health

shell

Example Responses

{
  "status": "healthy",
  "neo4j": "connected",
  "version": "1.0.0"
}

json

application/json

Get knowledge base statistics

GET

http://localhost:8000

/api/stats

Returns counts of documents, chunks, entities, and relationships

Get knowledge base statistics › Responses

200

Statistics retrieved

document_count

integer

chunk_count

integer

entity_count

integer

relationship_count

integer

per_chunk_relationship_count

integer

Relations discovered in Step 1 (per-chunk extraction)

collection_count

integer

GET/api/stats

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

shell

Example Responses

{
  "document_count": 0,
  "chunk_count": 0,
  "entity_count": 0,
  "relationship_count": 0,
  "per_chunk_relationship_count": 0,
  "collection_count": 0
}

json

application/json

Prometheus metrics

GET

http://localhost:8000

/metrics

Prometheus exposition-format metrics. Admin-only and not routed through the production nginx. Returns 404 when metrics are disabled and 501 when prometheus-client is not installed in the image.

Prometheus metrics › Responses

Metrics in Prometheus text exposition format

string

Get UI feature flags

GET

http://localhost:8000

/api/features

Lightweight, non-admin feature flags for gating UI features (Collections, Skills, Git integration, Web import) without exposing the full system configuration. Requires read permission.

Get UI feature flags › Responses

200

Feature flags

enable_collections

boolean

enable_skills

boolean

enable_git_integration

boolean

enable_web_crawl

boolean

True only when the master switch is on AND a crawl service is configured

GET/api/features

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

shell

Example Responses

{
  "enable_collections": true,
  "enable_skills": true,
  "enable_git_integration": true,
  "enable_web_crawl": true
}

json

application/json

Documents