User Settings Main Page -> Google API Key Setup

Google API Key Setup

Summary

This page allows you to connect your own Google Gemini API key to awaBerry, enabling access to advanced intelligence features. By providing your own key, you gain more control over your usage and can potentially enjoy unlimited access to awaBerry intelligence routines, depending on your subscription. If you choose not to use your own key, awaBerry will use its default settings, which may have usage limitations.

Page Access

You can access this page by navigating to: /user_googleapikey

Page Functionalities

Use your own Google Studio API key (Switch)

This switch allows you to toggle between using awaBerry's default intelligence settings and providing your own Google Gemini API key. When the switch is ON, you can enter your personal API key. When it's OFF, awaBerry will use its integrated default settings.

How to setup Google Studio API key? (Link)

Clicking this link will open a web page with frequently asked questions (FAQ) and detailed instructions on how to obtain and set up your Google Gemini API key. This is helpful if you are new to Google Gemini API keys or need assistance with the setup process.

Google Studio API Key (Text Field)

This field appears only when the "Use your own Google Studio API key" switch is turned ON. Here, you should paste your Google Gemini API key. The key you provide will be used by awaBerry for intelligence routines.

Key test did not work (Error Message)

If you see this message, it means that the Google Gemini API key you provided could not be verified by awaBerry. This might be due to an incorrect key, an expired key, or a problem with Google's services. Please double-check your key and ensure it's valid.

Test and store key (Button)

This button appears when the "Use your own Google Studio API key" switch is ON. Clicking it will first test your entered API key to ensure it's valid and working. If the test is successful, your key will be securely stored and used by awaBerry for intelligence routines.

Update (Button)

This button appears when the "Use your own Google Studio API key" switch is OFF. Clicking it will save your preference to use awaBerry's default intelligence settings and clear any previously stored custom API key.

Informational Text

  • Unlimited Command Explain: This text explains that for potentially unlimited usage of awaBerry intelligence, you should provide your own Google Studio API Key, especially relevant based on your subscription.
  • Model Gemini Flash is Used: This informs you that when Google Studio is activated with your key, the Gemini Flash 2.5 lite model is used, which is generally free for non-intensive usage.
  • Not provided key is stored encrypted: This provides assurance that any Google Gemini API key you provide is stored securely in an encrypted format.

Scenario Executions

Possible usage steps within this page

Here are some common ways you might use this page to manage your Google API key:

1. Setting up a new, valid API key

  1. Navigate to the Google API Key Setup page.
  2. Ensure the "Use your own Google Studio API key" switch is currently OFF.
  3. Toggle the "Use your own Google Studio API key" switch to the ON position.
  4. A text field will appear. Enter your valid Google Gemini API key into this field.
  5. Click the "Test and store key" button.
  6. If successful, you will see a temporary message like "Google API key stored", and you will be redirected to the previous screen.

2. Disabling custom API key usage

  1. Navigate to the Google API Key Setup page.
  2. Ensure the "Use your own Google Studio API key" switch is currently ON (indicating you are using a custom key).
  3. Toggle the "Use your own Google Studio API key" switch to the OFF position.
  4. Click the "Update" button.
  5. Your custom API key will be cleared, awaBerry will revert to using its default intelligence settings, and you will be redirected to the previous screen.

3. Updating an existing valid API key

  1. Navigate to the Google API Key Setup page.
  2. The "Use your own Google Studio API key" switch should be ON, and your current API key will be displayed in the text field.
  3. Replace the existing key in the text field with your new, valid Google Gemini API key.
  4. Click the "Test and store key" button.
  5. If successful, you will see a temporary message like "Google API key stored", and your new key will be saved and used by awaBerry. You will then be redirected to the previous screen.

Possible errors which may occur on this page

Understanding potential errors can help you troubleshoot issues quickly:

1. "Key test did not work" error

This error occurs after you have entered an API key and clicked "Test and store key", but awaBerry could not successfully verify the key with Google's services. This can happen if:

  • The API key was typed incorrectly or contains a typo.
  • The API key has expired or been revoked.
  • There are network connectivity issues preventing communication with Google's API.
  • The API key does not have the necessary permissions enabled in your Google Cloud Project.

To resolve this, please re-check your API key for accuracy, ensure it's still active, and verify its permissions in your Google Cloud Console.

2. "Please provide your Google Studio API key" validation message

This message appears below the text field if you have the "Use your own Google Studio API key" switch turned ON, but you've left the API key text field empty and tried to click "Test and store key".

To resolve this, simply enter your Google Gemini API key into the designated text field before attempting to save.