API Keys

Access BuildVision programmatically for custom integrations.

What Are API Keys?

API keys let you:

• Build custom integrations
• Automate workflows
• Connect other software
• Export data programmatically

Creating an API Key

Go to API Keys

Navigate to Settings → API Keys.

Click Generate

Click + Generate New Key.

Name Your Key

Give it a descriptive name:

• "Excel Integration"
• "Accounting Sync"
• "Zapier Connection"

Set Permissions (Optional)

Limit what the key can access:

• Read only
• Specific modules
• Full access (default)

Generate

Click Generate Key.

Copy Key

Important: Copy the key now. It won't be shown again.

Managing Keys

Viewing Keys

Your keys list shows:

• Key name
• Created date
• Last used date
• Status (Active/Revoked)

The actual key value is hidden after creation.

Revoking Keys

If a key is compromised:

1. Click the key name
2. Click Revoke
3. Confirm

Revoked keys stop working immediately.

Regenerating Keys

To get a new key value:

1. Revoke the old key
2. Create a new key
3. Update your integrations

Using API Keys

Authentication

Include your API key in requests:

# Header authentication (recommended)
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.buildvision.me/v1/projects
 
# Query parameter (less secure)
curl https://api.buildvision.me/v1/projects?api_key=YOUR_API_KEY

Base URL

https://api.buildvision.me/v1/

Common Endpoints

Rate Limits

API requests are limited:

Exceeding limits returns 429 Too Many Requests.

Security Best Practices

Do

• Store keys in environment variables
• Use secrets management (Vault, AWS Secrets)
• Rotate keys periodically
• Monitor key usage

Don't

• Commit keys to Git
• Share in chat/email
• Use in client-side code
• Give keys unnecessary permissions

Key Rotation

Regularly rotate keys:

1. Create new key
2. Update integrations to use new key
3. Verify integrations work
4. Revoke old key

Example Integrations

Export to Excel

import requests
 
API_KEY = "your_api_key"
PROJECT_ID = "project_123"
 
response = requests.get(
    f"https://api.buildvision.me/v1/takeoffs/{PROJECT_ID}/items",
    headers={"Authorization": f"Bearer {API_KEY}"}
)
 
items = response.json()
# Process and export to Excel

Zapier/Make

Connect via webhook:

1. Create API key
2. Use in Zapier webhook
3. Trigger automations on BuildVision events

Accounting Software

Sync invoices:

1. Fetch invoices via API
2. Transform data format
3. Push to accounting system

Troubleshooting

Q: Getting 401 Unauthorized

• Check key is correct
• Verify key isn't revoked
• Ensure proper header format

Q: Getting 403 Forbidden

• Key may lack required permissions
• Endpoint may be restricted
• Check your plan includes API access

Q: Rate limited

• Implement request caching
• Add delays between requests
• Upgrade plan for higher limits

API Documentation

Full API documentation available at:

• Swagger/OpenAPI spec
• Postman collection
• SDK libraries (coming soon)

Contact support for developer resources.

Next Steps

• Integrations - Pre-built connections
• Settings - Other configuration
• Contact Support (opens in a new tab) - API questions