Documentation

Open API

Public API

Three public surfaces: an examples endpoint, a news feed and the MCP Streamable HTTP endpoint. All are rate-limited per IP.

GET /api/public/ckf/example

Returns a compiled CKF package built from one of the bundled examples. Inspect the schema without running the compiler locally. Cached 1 hour. Limit: 60 requests / IP / hour.

Query params: topic = learning (default) or business; format = json (default), markdown, or yaml.

yaml
curl https://compiledknowledgeformat.org/api/public/ckf/example?topic=learning&format=json
yaml
curl -H "Accept: text/markdown" \
  https://compiledknowledgeformat.org/api/public/ckf/example?topic=business&format=markdown

GET /api/public/posts

Published CKF news posts as a JSON feed. Each item links to the human article and to the.ckf companion. Cached 10 minutes. Limit: 120 requests / IP / hour.

Query params: lang = en (default) or pt; limit up to 100.

yaml
curl https://compiledknowledgeformat.org/api/public/posts?lang=en&limit=20
json
{
  "count": 1,
  "lang": "en",
  "items": [
    {
      "slug": "ckf-project-review-from-0-1-to-compiler-v1-03-1",
      "title": "...",
      "excerpt": "...",
      "category": "Research",
      "date": "2026-05-22",
      "author": "Paulo Tomazinho, PhD",
      "reading_minutes": 12,
      "tags": ["compiler", "history"],
      "url": "https://compiledknowledgeformat.org/news/<slug>",
      "ckf_url": "https://compiledknowledgeformat.org/news/<slug>.ckf"
    }
  ]
}

POST /api/mcp

Model Context Protocol (Streamable HTTP) endpoint. JSON-RPC 2.0 over POST. Exposes the full CKF toolset to Claude Desktop, Cursor, Windsurf, AI SDK, OpenAI Agents SDK and any other MCP-compatible client. The default compile tool (ckf.compile) is the heuristic compiler — zero-config, no key, no auth, always works. ckf.compile_llm is the opt-in LLM upgrade (BYOK, or Advanced AI for admin/allowlist) and produces richer inference with reduced composition hallucination. Rate limits per IP: 30/h for ckf.compile (heuristic), 12/h for ckf.compile_llm (LLM). Full reference in MCP Server.

yaml
curl -X POST https://compiledknowledgeformat.org/api/mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Compile your own (BYOK)

The hosted compiler at /compiler is open without login. Bring your own API key from one of the five supported providers and compile any text into a CKF package in the browser. No data is stored for anonymous sessions. See BYOK providers.

Licensing

The CKF spec and reference implementation are MIT-licensed. See Open CKF on GitHub.

CKF v1.0 for this page has not been compiled yet. Downloads become available once an admin runs the compiler.