caliper uidocs
DemoSign inGet Pro

API keys

Pro

A list of API keys with create, reveal, copy and revoke.

Installs components/ui/api-keys.tsxDepends on @radix-ui/react-dialog, @radix-ui/react-popover, @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/api-keys

Keys let your code call the API. Keep them secret and scope them to what they need.

API keys
NameStatusActions
Production serverCreated Mar 4, 2025Active
CI pipelineCreated Jun 18, 2025 · expires Dec 18, 2025Active
Old staging keyCreated Nov 2, 2024Revoked

When to use #

Use it for

  • Managing credentials for a developer account.
  • Keys are shown once, at creation.

Skip it when

  • The secret is never shown to the user.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/api-keys

Adds its 10 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx
import { ApiKeys } from "@/components/ui/api-keys"

The worked example comes with Pro

The 38-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

ApiKeys

component
PropTypeDefaultDescription
keys *readonly ApiKey[]—
scopes *readonly KeyScope[]—
expiriesreadonly { value: string; label: string; }[][{ value: "never", label: "Never" }, { value: "30d", label: "30 days" }, { value: "90d", label: "90 days" }]
onCreate *(draft: NewKey) => Promise<{ secret: string; }>—Returns the new secret. Throw to show an error.
onRotate((id: string) => Promise<{ secret: string; }>)—
onRevoke *(id: string) => void—
classNamestring—

Accessibility #

It exposes status and alert semantics, with aria-label and aria-hidden kept in step with state. Changes that matter are announced through a live region.

Keyboard and focus handling comes from Radix dialog and popover: arrow keys move through items, Enter and Space select, and Escape closes and returns focus.

Motion #

It declares no animation in its component source. Any transition comes from its stylesheet, which uses the duration tokens that collapse to instant under prefers-reduced-motion.