Manage API keys — VeldrixAI Docs

Key types

Prefix	Environment	Counts against quota?
`vx-live-`	Production	Yes
`vx-test-`	Sandbox / development	No

The SDK validates the prefix and rejects keys that use underscores. The format is vx-live- with dashes, not vx_live_.

Creating a key

Open Settings → API Keys in the dashboard.

Click Create key, give it a descriptive name (e.g. prod-backend), and choose the environment.

Copy the key immediately — only a short prefix is stored and shown afterward.

Using a key

Pass it to the SDK, or send it as a bearer token over REST. Prefer environment variables over hard-coding.

PythonREST

import veldrixai, os

# Reads VELDRIX_API_KEY from the environment
client = veldrixai.Veldrix.from_env()
# or explicitly:
client = veldrixai.Veldrix(api_key=os.environ["VELDRIX_API_KEY"])

curl https://api.veldrixai.ca/trust/evaluate \
  -H "Authorization: Bearer $VELDRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"...","response":"...","model":"gpt-4o"}'

Rotating & revoking

Rotate keys on a schedule and whenever a key may have been exposed. Create the new key, deploy it, then revoke the old one from the dashboard — revocation takes effect immediately. Each key shows a last-used timestamp to help you spot stale credentials.

Security best practices

Use a dedicated key per service so you can revoke narrowly.
Never expose vx-live- keys in browser/client-side code — call VeldrixAI from your backend.
Store keys in a secret manager (AWS Secrets Manager, Vault, Doppler), not in .env committed to git.

Was this page helpful?