synpulse8-opensourcesynpulse8-opensource/pulse8-ai-cortex-knowledge-vault/.cursor/skills/cortex-api/SKILL.md

cortex-api

Skill15 starsChanged 5 months agoApache-2.0View on GitHub

Cortex REST API at /api/v1 — notes, search, graph, ingest, compile, bulk-ingest, feedbacks. Use for curl, HTTP clients, or FastAPI route changes.

Reads credentials

In this repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- cortex-authSkill
- cortex-compilerSkill
- cortex-contributingSkill
- cortex-deploySkill
- cortex-feedbackSkill
- cortex-graph-searchSkill
- cortex-mcpSkill
- cortexSkill
- cortex-vaultSkill

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
When AUTH_METHOD is not none, protected routes require:
line 16

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

Cortex REST API

Router: cortex/api/routes.py, mounted at /api/v1 in cortex/main.py.

OpenAPI: http://localhost:8420/docs

Authentication

When AUTH_METHOD is not none, protected routes require:

x-api-key: <API_KEY> when apikey, or
Authorization: Bearer <token> when oidc (API key also accepted as fallback)

Unprotected prefixes (cortex/auth/middleware.py):

/api/v1/health, /api/v1/login, /api/v1/auth/callback
/mcp, /.well-known/, /docs, /redoc, /openapi.json

Logging

Stream	Source	Example
stdout	`uvicorn.access`	`INFO: … "GET /api/v1/graph/stats" 200 OK`
stderr	`cortex.*` loggers	`INFO [cortex.api.routes] Bulk ingest request received: …`

Tail both: docker logs <container> 2>&1 | grep bulk

App logging configured in cortex/main.py via logging.basicConfig.

Shared logic with MCP

Many endpoints call the same functions as MCP (cortex/mcp/tools.py) or vault modules directly. Changing behavior usually requires updating both surfaces.

Endpoint summary

See reference.md for method, path, and tags.

Common request bodies

Feedback (POST /feedbacks):

{
  "content": "…",
  "tags": ["admin-review"],
  "related_paths": ["wiki/article.md"]
}

Bulk ingest (POST /bulk-ingest):

{
  "source_dir": "/ingest",
  "concurrency": 4,
  "force": false,
  "dry_run": false
}

source_dir must exist on the server filesystem (e.g. /ingest in Docker, not a host path).

Related skills

MCP: cortex-mcp
Auth: cortex-auth
Compiler endpoints: cortex-compiler

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free