API Keys

API keys authenticate test runs submitted to TraceLoom. Every run must include a valid API key so TraceLoom can associate the run with your account and route results to the correct dashboard.

Creating an API Key

1. Navigate to Settings → API Keys in the TraceLoom dashboard.
2. Click Create Key.
3. Enter a descriptive name (e.g., ci-github-actions or local-dev).
4. Copy the key value immediately — it is shown only once.

Keys have the format tlk_ followed by a random string. Store the key in a secure location such as a password manager or CI secrets store.

Using an API Key

Set the key as an environment variable before running your tests:

export TRACELOOM_API_KEY=tlk_your_key_here

In a GitHub Actions workflow:

- name: Run TraceLoom tests
  env:
    TRACELOOM_API_KEY: ${{ secrets.TRACELOOM_API_KEY }}
  run: npx traceloom run

Key Security

• Treat API keys like passwords — do not commit them to source control.
• Use separate keys for CI and local development so you can revoke them independently.
• Keys are hashed before storage; TraceLoom cannot retrieve the original value after creation.

Revoking a Key

To revoke a key, click the delete icon next to it in Settings → API Keys. Revocation is immediate — any in-flight runs using the key will fail authentication. Create a new key if needed before revoking the old one.

Back to Quick Start