Skip to main content

Authentication

Secure your API requests with proper authentication.

API Keys​

Vagary Voice uses API keys for authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Creating API Keys​

  1. Go to Dashboard → Settings → API Keys
  2. Click Generate New Key
  3. Give your key a descriptive name
  4. Copy and securely store the key
caution

API keys are shown only once. Store them securely and never commit them to version control.

Key Scopes​

ScopeAccess Level
readRead-only access to resources
writeCreate and update resources
deleteDelete resources
adminFull administrative access

Example Request​

curl -X GET https://api.vagaryvoice.cloud/v1/bots \
  -H "Authorization: Bearer vv_live_abc123xyz" \
  -H "Content-Type: application/json"

Best Practices​

  1. Never expose keys in client-side code
  2. Use environment variables to store keys
  3. Rotate keys regularly - especially after team changes
  4. Use minimum required scopes
  5. Monitor key usage in the dashboard

Key Rotation​

To rotate an API key:

  1. Generate a new key
  2. Update your applications to use the new key
  3. Verify the new key works
  4. Delete the old key

Rate Limiting​

See API Overview for rate limit details.