LynxoLynxo Docs

API Keys Management

API keys are essential for authenticating and securing your integrations with Lynxo. This section explains how to create, manage, and use API keys for your integrations.

Overview

API keys provide secure access to Lynxo's API endpoints. Each key is associated with your account and can be scoped to specific permissions and integrations.

Creating API Keys

  1. Log in to your Lynxo dashboard
  2. Navigate to Developers → API Keys
  3. Click Create New API Key
  4. Provide a descriptive name for the key
  5. Select the permissions and scopes required
  6. Copy and securely store your API key

⚠️ Important: API keys are only shown once when created. Make sure to copy and store them securely.

API Key Permissions

API keys can be configured with different permission levels:

  • Read Only - Can retrieve data but cannot modify
  • Read/Write - Can retrieve and modify data
  • Full Access - Complete access to all API endpoints
  • Custom Scopes - Granular permissions for specific operations

Using API Keys

Include your API key in the Authorization header of your API requests:

curl -X GET "https://api.lynxo.ai/v1/jobs" \
  -H "Authorization: Bearer YOUR_API_KEY"

Best Practices

Security

  • Never commit API keys to version control
  • Rotate keys regularly - Update keys every 90 days
  • Use environment variables - Store keys securely in your application configuration
  • Limit key permissions - Only grant the minimum permissions required
  • Monitor key usage - Regularly review API key activity logs

Key Management

  • Use separate keys for different environments (development, staging, production)
  • Create keys for specific integrations - Don't reuse keys across multiple services
  • Name keys descriptively - Use clear names that indicate the key's purpose
  • Document key usage - Keep track of which keys are used where

Revoking API Keys

If an API key is compromised or no longer needed:

  1. Navigate to Developers → API Keys
  2. Find the key you want to revoke
  3. Click Revoke and confirm the action
  4. Update your integrations to use a new key

Revoked keys cannot be restored. You'll need to create a new key if access is required again.

API Key Limits

  • Each account can have up to 50 active API keys
  • API keys do not expire automatically
  • Rate limits apply per API key
  • Usage is tracked and displayed in the dashboard

Troubleshooting

Invalid API Key Error

If you receive an "Invalid API Key" error:

  1. Verify the key is copied correctly (no extra spaces)
  2. Check that the key hasn't been revoked
  3. Ensure you're using the correct key for your environment
  4. Verify the Authorization header format: Bearer YOUR_API_KEY

Rate Limit Exceeded

If you hit rate limits:

  1. Check your API key usage in the dashboard
  2. Implement request throttling in your application
  3. Consider upgrading your plan for higher limits
  4. Contact support if you need temporary limit increases

For additional support, visit the Errors section or contact our support team.