API Keys

Manage your VisionPipe API keys for server-side integration.

Creating an API Key

1. Sign in at visionpipe.com/login
2. Navigate to Cloud Console → API Keys
3. Click Add Key
4. Enter a descriptive name (e.g., "Production", "Development")
5. Click Create Key
6. Copy your key immediately - you won't be able to see it again

Key Format

API keys use the format:

vp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• vp_live_ - Prefix identifying VisionPipe keys
• 64 hex characters - Cryptographically random identifier

Security

Hashed Storage

For your security, we only store a SHA-256 hash of your API key. This means:

• We cannot retrieve your key if you lose it
• Even if our database is compromised, your keys are safe
• You must copy the key when it's first displayed

Best Practices

• Never commit keys to git - Use environment variables
• Use different keys for development and production
• Rotate keys periodically - Delete old keys and create new ones
• Delete unused keys - Reduce attack surface

Using Your API Key

HTTP Header (Recommended)

curl -X POST https://visionpipe3d.quochuy.dev/v1/detect \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_url": "https://example.com/image.jpg"}'

Environment Variables

# .env
VISIONPIPE_API_KEY=vp_live_xxxx...

# Node.js
const apiKey = process.env.VISIONPIPE_API_KEY;

Managing Keys

View Keys

Go to API Keys to see all your keys with:

• Key name
• Key prefix (first 12 characters)
• Last used date
• Created date

Delete Keys

Click Delete next to any key to revoke it immediately. Deleted keys:

• Cannot be used for new requests
• Are soft-deleted for audit compliance
• Cannot be recovered

Audit Logging

All key operations are logged for security:

• Key creation (with IP address)
• Key deletion (with IP address)
• Key usage (last used timestamp)

These logs are available for 90 days and can be requested for compliance purposes.