API Keys

Create and manage API keys for authenticating your applications with TuringPulse.

Overview

API keys are used to authenticate your SDK and API requests. Each key is scoped to a project and has configurable permissions.

Creating API Keys

  1. Navigate to Admin → API Keys
  2. Click Create API Key
  3. Enter a name (e.g., "Production SDK")
  4. Select permissions
  5. Click Create
  6. Copy the key immediately (it won't be shown again)
⚠️
Security
API keys are shown only once when created. Store them securely and never commit them to version control.

Key Types

PrefixTypeUse Case
sk_live_ProductionProduction applications
sk_test_TestDevelopment and testing

Using API Keys

SDK Initialization

from turingpulse_sdk import init, TuringPulseConfig

# Option A: Environment variable (recommended — most secure)
# export TP_API_KEY=sk_live_your_api_key
# No init() call needed — the SDK reads TP_API_KEY automatically

# Option B: Programmatic init
init(TuringPulseConfig(
    api_key="sk_live_your_api_key",
    workflow_name="My Workflow",
))

API Requests

curl -X GET https://api.turingpulse.ai/v1/workflows \
  -H "Authorization: Bearer sk_live_your_api_key"

Permissions

API keys can have the following permissions:

  • traces:write - Send traces and spans
  • traces:read - Read trace data
  • workflows:read - List and view workflows
  • evals:write - Run evaluations
  • evals:read - Read evaluation results
  • config:read - Read configuration
  • config:write - Modify configuration

Managing Keys

  • View - See key metadata (not the key itself)
  • Rotate - Generate new key, invalidate old
  • Revoke - Immediately disable the key
  • Edit - Update name or permissions

Best Practices

  • Use separate keys for production and development
  • Grant minimum required permissions
  • Rotate keys periodically
  • Revoke unused keys
  • Use environment variables, not hardcoded keys

Next Steps