Knowledge Base

Structured tutorials and reference knowledge—organized for learning and lookup

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
General

`/api/articles`

# `/api/articles` ## Overview The `/api/articles` endpoint serves as the primary interface for managing developer documentation and knowledge base content on codcompass.com. It supports bulk creation/

·3 read
General

`/api/analytics` — Event Ingestion API

# `/api/analytics` — Event Ingestion API ## 1. Overview The `/api/analytics` endpoint serves as the primary ingestion route for behavioral, interaction, and system telemetry events within the codcompa

·3 read
General

/api/ai/review — Code Review Endpoint

# /api/ai/review — Code Review Endpoint ## Overview The `/api/ai/review` endpoint provides a lightweight, rule-based static analysis service for submitted source code. Designed as a fast-feedback mech

·3 read
General

GET /api/admin/users

# GET /api/admin/users ## 1. Overview The `GET /api/admin/users` endpoint provides a comprehensive listing of all registered user accounts within the platform. It is designed primarily for platform ad

·3 read