• Docs
  • Components
  • Blocks
  • Admin
CtrlK
Get Started
  • Introduction
  • Setup
  • CLI
  • VS Code Extension
  • Figma Code Connect
  • MCP Server
  • llms.txt
  • Changelog
Foundations
  • Design Tokens
  • Theming & Modes
  • Semantic Colors
  • Spacing
  • Typography
Testing
  • Test Guide
  • Performance Tests
  • Visual Regression
Components
  • Accordion
  • Activity Feed
  • Alert
  • Avatar
  • Badge
  • Breadcrumbs
  • Button
  • Card
  • Carousel
  • Checkbox
  • Collapsible
  • Combobox
  • Command Palette
  • Context Menu
  • Date Picker
  • Dialog
  • Dropdown Menu
  • File Upload
  • Hover Card
  • Input
  • Kbd
  • Label
  • Menubar
  • Metric Card
  • Multi Select
  • Navigation Menu
  • Pagination
  • Popover
  • Progress
  • Quick Actions
  • Radio
  • Rating
  • Resizable
  • Segmented Control
  • Select
  • Separator
  • Sheet
  • Skeleton
  • Slider
  • Spinner
  • Split Button
  • Stepper
  • Switch
  • Table
  • Tabs
  • Tag Input
  • Textarea
  • Timeline
  • Toast
  • Toggle
  • Toggle Group
  • Tooltip
  • Tree View
Blocks
  • Activity Feed
  • App Shell
  • Authentication Block
  • Benefits Section
  • Cta Section
  • Data Table
  • Empty State
  • Faq Section
  • Feature Grid Section
  • Footer Section
  • Hero Section
  • Kpi Dashboard
  • Kpi Strip
  • Link Card
  • Metric Card
  • Navigation Header
  • Pagination Footer
  • Pricing Table
  • Quick Actions
  • Settings Screen
Resources
  • API Reference
Settings ScreenExamples

API

API reference for endpoints exposed by the documentation site.

Quick links

  • Tools (Analytics / Governance)
  • Setup

Overview

  • Docs site API (apps/www): small set of endpoints used by documentation rendering and the Tools pages. Base URL: current site origin (http://localhost:3001 in your dev setup).

Docs site API (apps/www)

These endpoints are implemented in apps/www/app/api/**.

POST /api/highlight-code

Syntax-highlight code blocks for the docs UI.

Request body

Response

GET /api/analytics/component-usage

Used by /tools/component-analytics. Currently returns mock data.

Query params

GET /api/governance/compliance

Used by /tools/governance. Currently returns mock data.

Query params

POST /api/telemetry

Dev-only logging stub used for telemetry ingestion.

Request body (shape)

Error handling

Most endpoints use standard HTTP status codes (400/401/404/500) and return JSON with an error or message.

Settings ScreenExamples