General
User Bookmarks API
# User Bookmarks API ## Overview The `/api/user/bookmarks` endpoint provides a centralized interface for authenticated users to manage their saved articles. It supports four core operations: checking
·3 read
Learning Paths
Knowledge Base
Structured tutorials and reference knowledge—organized for learning and lookup
General
GET /api/series
# GET /api/series ## Overview The `/api/series` endpoint retrieves a curated list of published article series from the CodCompass knowledge base. Each returned series object contains its core metadata
·3 read
General
`/api/search` API Documentation
# `/api/search` API Documentation ## Overview The `/api/search` endpoint provides a unified interface for full-text article discovery and contextual content recommendations. It is designed to power fr
·3 read
General
`/api/newsletter/subscribe`
# `/api/newsletter/subscribe` ## Overview The `/api/newsletter/subscribe` endpoint provides a public, unauthenticated interface for managing newsletter subscription records. It serves two primary func
·3 read
General
Returns limit: 20 in the response body
## Overview The `/api/local-only/run-history` endpoint provides a lightweight, query-driven interface for retrieving recent crawler execution records. Designed primarily for local development, debuggi
·3 read
General
GET /api/local-only/crawl-library
# GET /api/local-only/crawl-library ## Overview The `/api/local-only/crawl-library` endpoint provides a read-only, paginated interface for querying the locally stored crawl library. It is designed for
·3 read
General
`/api/local-only/config`
# `/api/local-only/config` ## Overview The `/api/local-only/config` endpoint provides programmatic access to the local crawler configuration system. It enables developers, automation scripts, and admi
·3 read
General
Category Statistics API
# Category Statistics API ## Overview The `/api/local-only/category-stats` endpoint provides aggregated content metrics for each knowledge base (KB) category. It is designed primarily for internal cra
·3 read
General
`/api/checkout/create-session`
# `/api/checkout/create-session` ## Overview The `/api/checkout/create-session` endpoint acts as a lightweight price resolution and configuration utility for Paddle subscription billing. Rather than i
·3 read
General
`/api/articles/ingest/simhashes`
# `/api/articles/ingest/simhashes` ## Overview The `/api/articles/ingest/simhashes` endpoint provides authenticated clients with a sampled list of SimHash fingerprints for existing knowledge base arti
·3 read
General
Batch Article Ingestion API
# Batch Article Ingestion API ## Overview The `/api/articles/ingest/batch` endpoint provides a programmatic interface for submitting multiple articles to the platform in a single HTTP request. Designe
·3 read
General
PATCH /api/articles/[id]
# PATCH /api/articles/[id] ## Overview The `PATCH /api/articles/[id]` endpoint enables partial updates to existing articles within the CodCompass knowledge base. It is designed for content management
·3 read