Authentication

​

Overview

​

API Key Authentication

​

Getting Your API Key

1. Register an Account: Visit https://api.vects.ai/auth/register to create your account
2. Generate API Key: Once logged in, navigate to the API Keys section in your dashboard
3. Copy Your Key: Save your API key securely - it won’t be shown again

​

Using API Keys

curl -X POST "https://api.vects.ai/api/v1/simulations/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create a city simulation with traffic"
  }'

​

Token Authentication

​

Getting a Token

curl -X POST "https://api.vects.ai/auth/token/" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your_username",
    "password": "your_password"
  }'

{
  "token": "your_auth_token_here"
}

​

Using Tokens

curl -X GET "https://api.vects.ai/auth/user/" \
  -H "Authorization: Token your_auth_token_here"

​

Rate Limits

• Free Tier: 100 requests per hour
• Pro Tier: 1,000 requests per hour
• Enterprise: Custom limits

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

​

Error Responses

{
  "error": "Invalid API key",
  "code": "INVALID_API_KEY"
}

​

Best Practices

1. Rotate Keys Regularly: Generate new API keys periodically
2. Use Environment Variables: Never hardcode keys in your source code
3. Monitor Usage: Track your API usage in the dashboard
4. Implement Retry Logic: Handle rate limits gracefully with exponential backoff