Skip to main content
DocsFeaturesBring Your Own API Key (BYOK)

Bring Your Own API Key (BYOK)

Coming soon

Illustration

Overview of BYOK

The Bring Your Own API Key (BYOK) feature is designed specifically for Ultra subscribers of the Evelant browser extension. This capability allows users to integrate their own API keys from prominent providers such as Gemini, OpenAI, or Anthropic. By using your personal API key, all usage will be billed directly by your chosen provider. This is particularly beneficial for power users who already possess their own API access and prefer to have effectively unlimited usage without relying on Evelant's shared credit pool.

Benefits of BYOK

  1. Cost Efficiency: Using your own API key means you can avoid potential overage charges associated with Evelant's shared credit pool.
  2. Increased Control: You maintain full control over your API usage and billing, allowing for better financial management.
  3. Enhanced Performance: Direct access to your provider's API may offer improved response times and reliability, as you are not sharing resources with other users.
  4. Unlimited Usage: For users who have higher usage requirements, BYOK provides a pathway to use the service without limits imposed by shared credits.

Getting Started with BYOK

While the BYOK feature is still in development, it is helpful to understand the general steps that will be required to set it up once it becomes available. Here’s a step-by-step guide on what users can expect:

Step 1: Acquire Your API Key

  1. Choose Your Provider: Decide whether you want to use Gemini, OpenAI, or Anthropic as your API provider.
  2. Sign Up or Log In: Create an account or log into your existing account on the provider's website.
  3. Create an API Key:
    • Navigate to the API section of your account dashboard.
    • Look for an option labeled “Create New API Key” or similar.
    • Follow the prompts to generate your key. Be sure to copy it securely.

Step 2: Accessing the Evelant Extension

  1. Open Your Browser: Launch the browser where you have Evelant installed.
  2. Open the Extension: Click on the Evelant icon in your browser toolbar to access the extension interface.
  3. Navigate to Settings: Look for a gear icon or a menu option labeled “Settings” within the extension.

Step 3: Enter Your API Key

  1. Find BYOK Section: In the settings menu, look for a section specifically designated for BYOK.
  2. Input Your API Key: Paste your API key into the designated field.
  3. Save Changes: Click on the “Save” button to ensure your API key is stored securely.

Step 4: Test Your Configuration

  1. Run a Basic Query: After saving your API key, run a simple query to verify that the integration works correctly.
  2. Check for Errors: If you encounter any issues, consult the troubleshooting section below.

Troubleshooting Common Issues

If you experience difficulties while setting up or using the BYOK feature, consider the following troubleshooting tips:

  • Invalid API Key Error: If you receive an error stating that your API key is invalid, double-check for any typos or extra spaces when pasting.
  • Quota Exceeded Notifications: If you are alerted that you have exceeded your quota, review your usage statistics via your API provider’s dashboard.
  • Connection Issues: Ensure that your internet connection is stable. Sometimes connectivity issues can interfere with API requests.

Frequently Asked Questions (FAQs)

Q1: When will BYOK be available?

A1: The BYOK feature is currently in development and is part of the Ultra roadmap. The Evelant team will update this documentation as soon as the feature is live.

Q2: Will I still be able to use the shared credit pool?

A2: Yes, if you choose not to integrate your own API key, you will continue to use Evelant’s shared credit pool as usual.

Q3: Can I switch back to the shared credit pool after using BYOK?

A3: Yes, users will be able to toggle between using their own API key and the shared credit pool as needed.

Q4: What happens if I lose access to my API key?

A4: If you lose access to your API key, you will need to generate a new one through your provider and update it in the Evelant settings to continue using the service.

Best Practices for Using Your API Key

  1. Keep Your Key Secure: Treat your API key like a password. Do not share it publicly or expose it in unsecured environments.
  2. Monitor Usage Regularly: Regularly check your API usage statistics to ensure you remain within your usage limits and avoid unexpected charges.
  3. Stay Updated on Provider Changes: API providers may update their terms of service or pricing models. Stay informed to adjust your usage accordingly.
  4. Utilize Environment Variables: If you are developing scripts or applications that utilize the API, consider storing your API key in environment variables instead of hardcoding them.

Conclusion

The Bring Your Own API Key feature is set to enhance the experience of Ultra subscribers by offering a more personalized and cost-effective solution for accessing AI services. As this feature continues to be developed, users are encouraged to stay tuned for updates and prepare for a seamless integration process. For any additional questions or feedback, please reach out to our support team.