Getting Started

API Keys

Generate, rotate, revoke, and safely use project-scoped API keys.

Scopes

Keys are project-scoped and issued with one of three permission levels.

Scope	Use
`readonly`	Read-only query and search workloads
`readwrite`	Default application key for read and write traffic
`admin`	Operational tasks that require elevated access

Using A Key

terminal

curl -X POST "$KYRODB_API_BASE_URL/v1/vectors/query" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $KYRODB_API_KEY" \
  -d '{"id":"doc-1"}'

Rotation Flow

Create the replacement key in the console.
Deploy the new key to your application.
Verify traffic is healthy.
Revoke the old key.
Delete the revoked key when you no longer need its metadata record.

Shown Once

The control plane stores only key metadata and a hash. The full secret is shown once at creation or rotation time.