The AI-Native Device Platform
User Manual

Google API Key Setup

This page allows you to manage your Google Gemini API key settings for awaBerry intelligence features, including enabling or disabling its use and testing your key.

Google API Key Setup

Summary

This page provides a dedicated area within the awaBerry application to manage your Google Gemini API key. You can decide whether to use your own personal Google API key for advanced intelligence features or rely on the application's default settings. If you choose to use your own key, the page will guide you through entering, testing, and securely storing it, ensuring that your awaBerry intelligence routines operate effectively.

Page Access

You can access this page by navigating to: /user_googleapikey

Page Functionalities

  • Switch ("Setup Google Studio API key"): This toggle allows you to switch between using your own Google Gemini API key and using the default awaBerry settings.
    • When enabled, an input field appears where you can enter your personal Google Gemini API key.
    • When disabled, the input field disappears, and the system will rely on its default intelligence settings.
  • Text Field ("Google Studio API key"): This field appears when you enable the "Setup Google Studio API key" switch. Here, you enter your unique Google Gemini API key.
    • Validation: The field will alert you if you try to submit it empty.
    • Security: Your entered key is encrypted and stored securely within the awaBerry cloud, linked to your two-factor authentication.
  • "Test and store key" Button: This button appears when "Setup Google Studio API key" is enabled. Clicking it performs two main actions:
    • It first tests your entered Google API key to ensure it is valid and working correctly with Google Gemini services.
    • If the key is valid, it then encrypts and securely stores your key in the awaBerry cloud for future use.
  • "Update" Button: This button appears when "Setup Google Studio API key" is disabled. Clicking it finalizes your choice to use the default awaBerry intelligence settings and clears any previously stored personal Google API key.
  • Information Text: Several text blocks explain how awaBerry intelligence uses Google Gemini, the benefits of providing your own key (e.g., using "Gemini 2.5 Flash Lite"), and the secure storage of your key.
  • Error Message Box: If the test of your Google API key fails, an error message "Test of key did not work - please check the key and try again." will be displayed prominently.

Scenario Executions

Possible usage steps within this page

  1. Setting Up Your Own Google API Key:
    • Navigate to the Google API Key Setup page.
    • Locate the switch labeled "Setup Google Studio API key" and turn it on.
    • A text field will appear. Carefully enter your unique Google Gemini API key into this field.
    • Click the "Test and store key" button.
    • The system will verify your key. If successful, you will see a "Google API key stored" confirmation message, and you will be returned to the previous page.
  2. Updating an Existing Google API Key:
    • If you have previously stored a key, it will appear pre-filled in the text field when you visit this page with the "Setup Google Studio API key" switch enabled.
    • Modify the key in the text field to your new Google Gemini API key.
    • Click the "Test and store key" button.
    • Upon successful validation, your new key will be stored, and a confirmation message will appear.
  3. Disabling the Use of Your Own Google API Key:
    • Navigate to the Google API Key Setup page.
    • Locate the switch labeled "Setup Google Studio API key" and turn it off.
    • The text field for the key will disappear.
    • Click the "Update" button.
    • Your preference to use default settings will be saved, and any previously stored personal API key will be cleared from the system. You will then be returned to the previous page.

Possible errors which may occur on this page

  1. Empty API Key Submission:
    • Error: "Please provide your Google Studio API key."
    • Reason: This error occurs if you attempt to "Test and store key" with the "Setup Google Studio API key" switch enabled, but you have left the Google Studio API key text field empty. The system requires an API key to be present before it can proceed with testing and storage.
    • Solution: Ensure you enter a valid Google Gemini API key into the designated text field before clicking the button.
  2. Invalid or Non-Functional API Key:
    • Error: "Test of key did not work - please check the key and try again."
    • Reason: This message appears if the system attempts to test your provided Google Gemini API key (by sending a small test command to Google Gemini) and the test fails. This could be due to an incorrectly typed key, an expired key, a key with insufficient permissions, or an issue with Google's API service at the time of the test.
    • Solution: Double-check that the API key you entered is correct. You might need to generate a new key from your Google Cloud Console or ensure that the existing key has the necessary permissions for the Google Gemini API. Try again after verifying the key.
Navigate ← User Settings Main Page ← awaBerry User Manual Main Page