API Reference
Complete API documentation for codcompass.com — endpoints, authentication, request/response formats, and usage examples.
Content
Paddle Webhook Handler (`/api/webhooks/paddle`)
# Paddle Webhook Handler (`/api/webhooks/paddle`) ## Overview The `/api/webhooks/paddle` endpoint serves as the primary integration point for receiving real-time billing and subscription lifecycle eve
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
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
`/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
`/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
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
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
`/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
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
`/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
`/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
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
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
`/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/
`/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
/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
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
`/api/admin/subscriptions` — Subscription Analytics Endpoint
# `/api/admin/subscriptions` — Subscription Analytics Endpoint ## Overview The `/api/admin/subscriptions` endpoint provides a real-time aggregation of subscription metrics across the entire user base.
/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
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
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
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