# Docs Site API Index

Api reference index page with endpoints grouped by resource and a filter by method.

- id: `docs-site-api-index`
- Page: https://agentic-ui-kit.com/components/docs-site-api-index
- Live preview: https://agentic-ui-kit.com/docs-site/docs/api?piece=docs-site-api-index

## Install

```bash
agentic-ui add docs-site-api-index
npx shadcn@4.17.0 add @agentic-ui/docs-site-api-index
```

## Metadata

- **Level:** page
- **Category:** page
- **Installable in:** Radix UI (registry variant new-york), Base UI (registry variant base-vega)
- **Capabilities:** resource-grouping, text-filter, method-filter, result-count-live-region, empty-state, version-aware-endpoints, new-and-deprecated-tags
- **Intents:** navigate, manage-collection
- **Suits domains:** devtools, knowledge, saas
- **Interaction:** radio-filter, text-filter, click
- **Screen role:** overview
- **Density:** comfortable
- **Dark mode:** yes
- **Use it for:** api reference index page with endpoints grouped by resource and a filter by method, list of REST endpoints with http method badges that links to each endpoint page
- **Avoid when:** a single endpoint with parameters (use the endpoint page)
- **Preserve when adapting:** single-h1-per-page, section-order, link-integrity
- **Replace when adapting:** brand-copy, content-data, links
- **Adaptation effort:** low
- **Coupling:** medium
- **Quality breakdown:** visual 9/10, responsive 9/10, accessibility 9/10, code 9/10
- **Uses primitives:** button, input
- **npm dependencies:** next, lucide-react, next-themes
- **Motion:** profile subtle, library css, reduced-motion fallback yes
- **Used in:** Documentation Site (blueprint)
- **npm dependencies (registry):** lucide-react@0.577.0
- **Registry dependencies:** lib-primitives, util-copy-block