Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vijil.ai/llms.txt

Use this file to discover all available pages before exploring further.

Vijil uses API keys to authenticate requests. You’ll need one key for local development, and potentially separate keys for CI/CD pipelines with different permission scopes.

​
Getting an API Key

1

Log In

Go to console.vijil.ai and log in
2

Navigate to Settings

Go to Settings > API Keys
3

Create Key

Click Create API Key and name it
4

Copy Key

Copy the key immediately - it will not be shown again

​
Using the API Key

export VIJIL_API_KEY="your-api-key"

from vijil import Client

# Automatically reads from environment
client = Client()

​
Direct Initialization

from vijil import Client

client = Client(api_key="your-api-key")
Never commit API keys to version control. Use environment variables or secrets management.

​
Configuration File

Create ~/.vijil/config.yaml: 
api_key: your-api-key

​
Key Permissions

API keys inherit team permissions:
ScopeCapabilities
Full AccessAll operations
Read OnlyView only
EvaluationsRun evaluations only

​
Key Rotation

Rotate keys regularly:
  1. Create new key
  2. Update your applications
  3. Revoke old key

​
Security Best Practices

  1. Use environment variables - Not hardcoded values
  2. Rotate regularly - Every 90 days recommended
  3. Limit scope - Use minimal permissions needed
  4. Monitor usage - Check for unauthorized access
  5. Revoke unused keys - Clean up old keys

​
Troubleshooting

​
”Invalid API Key”

  • Verify the key is correct
  • Check for extra whitespace
  • Ensure the key hasn’t been revoked

​
”Insufficient Permissions”

  • Check key scope matches operation
  • Verify team membership
  • Contact admin for access
Last modified on April 28, 2026