Docs Site API Endpoint
Api endpoint reference page with parameters table, request and response code samples in several languages and a try it panel.
Choose the primitives library your project already uses. Both look the same: your theme, not the variant, controls colors, shape, type and motion.
About this page
What it's for
- Api endpoint reference page with parameters table, request and response code samples in several languages and a try it panel.
- Three pane api documentation page: description, params with types and required, code samples, mocked try it response.
Includes
- Three pane layout
- Parameters table
- Required and type columns
- Request samples in four languages
- Response examples by status
- Try it panel
- Error scenarios
- Live request sample
Works with
- Radix UI and Base UI primitives (pick the one your project uses)
- React 19 and Tailwind CSS 4 in Next.js (App Router), Vite, React Router or TanStack Start, installed with the agentic-ui or shadcn CLI
- Your theme tokens, in light and dark mode
- 1 template or blueprint on this site use it (below)
Install
Included with Agentic UI Kit (one-time license). Install needs your license key: see pricing · connect your project.
Agentic UI CLI
agentic-ui add docs-site-api-endpointInstalls through shadcn and adapts the component to your design tokens.
shadcn CLI
npx shadcn@4.17.0 add @agentic-ui/docs-site-api-endpointUsed in
- Type
- Page
- Variants
- Radix UI and Base UI
- Themes
- Light and dark
- Widths
- Preview it at desktop, tablet and mobile widths above.
- Motion
- Animated, with a reduced-motion fallback
- Sample data
- Ships with sample data in
api-mock.ts,api-mock-body.ts,api-samples.ts; replace it with your own.
- npm packages
lucide-react- Registry dependencies
lib-primitivesutil-copy-block- Files
32 files
- components/agentic-ui/docs-site-api-endpoint/screens/api-endpoint.tsx
- components/agentic-ui/docs-site-api-endpoint/lib/types.ts
- components/agentic-ui/docs-site-api-endpoint/lib/api-model.ts
- components/agentic-ui/docs-site-api-endpoint/content/changelog.ts
- components/agentic-ui/docs-site-api-endpoint/content/api.ts
- components/agentic-ui/docs-site-api-endpoint/content/api-resources.ts
- components/agentic-ui/docs-site-api-endpoint/content/api-messages.ts
- components/agentic-ui/docs-site-api-endpoint/content/api-params.ts
- components/agentic-ui/docs-site-api-endpoint/content/api-config.ts
- components/agentic-ui/docs-site-api-endpoint/components/version-banner.tsx
- components/agentic-ui/docs-site-api-endpoint/components/docs-context.tsx
- components/agentic-ui/docs-site-api-endpoint/components/use-stored-version.ts
- components/agentic-ui/docs-site-api-endpoint/lib/versions.ts
- components/agentic-ui/docs-site-api-endpoint/content/versions.ts
- components/agentic-ui/docs-site-api-endpoint/components/params-table.tsx
- components/agentic-ui/docs-site-api-endpoint/components/rich-text.tsx
- components/agentic-ui/docs-site-api-endpoint/lib/inline.ts
- components/agentic-ui/docs-site-api-endpoint/components/method-badge.tsx
- components/agentic-ui/docs-site-api-endpoint/components/endpoint-console.tsx
- components/agentic-ui/docs-site-api-endpoint/components/try-it-result.tsx
- components/agentic-ui/docs-site-api-endpoint/components/code-view.tsx
- components/agentic-ui/docs-site-api-endpoint/lib/slug.ts
- components/agentic-ui/docs-site-api-endpoint/lib/api-mock.ts
- components/agentic-ui/docs-site-api-endpoint/lib/api-values.ts
- components/agentic-ui/docs-site-api-endpoint/lib/api-mock-body.ts
- components/agentic-ui/docs-site-api-endpoint/components/try-it-fields.tsx
- components/agentic-ui/docs-site-api-endpoint/lib/api-samples.ts
- components/agentic-ui/docs-site-api-endpoint/lib/value-format.ts
- components/agentic-ui/docs-site-api-endpoint/components/docs-layout.tsx
- components/agentic-ui/docs-site-api-endpoint/components/docs-sidebar.tsx
- components/agentic-ui/docs-site-api-endpoint/components/doc-parts.tsx
- components/agentic-ui/docs-site-api-endpoint/components/doc-chrome.tsx
Related components
Docs Site API Index
Api reference index page with endpoints grouped by resource and a filter by method.
Details and live previewDocs Site Article
Documentation article page with sidebar navigation and a sticky on this page table of contents.
Details and live previewDocs Site Changelog
Api changelog page with new, improved and fixed entries and links to the reference.
Details and live previewDocs Site Home
Documentation home page with search and quickstart cards for a developer API.
Details and live preview