Knowledge Base

Structured tutorials and reference knowledge—organized for learning and lookup

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
General

/api/admin/crawler

# /api/admin/crawler ## Overview The `/api/admin/crawler` endpoint serves as the primary programmatic interface for manually triggering and monitoring web crawler jobs within the platform. It is desig

·3 read
General

Manage Individual Articles (`/api/admin/articles/[id]`)

# Manage Individual Articles (`/api/admin/articles/[id]`) ## Overview The `/api/admin/articles/[id]` endpoint provides programmatic control over individual knowledge base articles within the CodCompas

·3 read
General

GET /api/admin/articles

# GET /api/admin/articles ## Overview The `GET /api/admin/articles` endpoint provides a public, unauthenticated interface for retrieving a list of articles from the codcompass knowledge base. Designed

·3 read
General

Admin Analytics API Endpoint

# Admin Analytics API Endpoint ## Overview The `/api/admin/analytics` endpoint provides a consolidated snapshot of platform statistics and engagement metrics for administrative dashboards. It is desig

·3 read