Google auth provider

The Google auth provider enables tools and agents to call Google/Google Workspace APIs on behalf of a user. Behind the scenes, the Arcade Engine and the Google auth provider seamlessly manage Google OAuth 2.0 authorization for your users.

What's documented here

This page describes how to use and configure Google auth with Arcade AI.

This auth provider is used by:

• The Arcade Google toolkit, which provides pre-built tools for interacting with Google services
• Your app code that needs to call Google APIs
• Or, your custom tools that need to call Google APIs

Configuring Google auth

How you configure the Google auth provider depends on whether you use the Arcade Cloud Engine or a self-hosted Engine.

With the Arcade Cloud Engine, you can start building and testing Google auth without any configuration. Your users will see Arcade AI (demo) as the name of the application that's requesting permission.

When you are ready to go to production, you'll want to configure the Google auth provider with your own Google app credentials, so users see your app name when they authorize access.

Create a Google app

• Follow Google's guide to setting up OAuth credentials (opens in a new tab)
• Choose the scopes (opens in a new tab) (permissions) you need for your app
• Set the redirect URL to: https://cloud.arcade-ai.com/api/v1/oauth/callback
• Copy the client ID and client secret

Configuring Google auth with the Arcade Cloud Engine

Configuring Google auth with a self-hosted Arcade Engine

export GOOGLE_CLIENT_ID="<your client ID>"
export GOOGLE_CLIENT_SECRET="<your client secret>"

GOOGLE_CLIENT_ID="<your client ID>"
GOOGLE_CLIENT_SECRET="<your client secret>"

auth:
  providers:
    - id: google
      client_id: ${env:GOOGLE_CLIENT_ID}
      client_secret: ${env:GOOGLE_CLIENT_SECRET}

Using Google auth in app code

Use the Google auth provider in your own agents and AI apps to get a user token for Google APIs. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for Google APIs:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "[email protected]"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="google",
    scopes=["https://www.googleapis.com/auth/gmail.send"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.authorization_url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# TODO: Do something interesting with the token...

Using Google auth in custom tools

The Arcade LLM API is a convenient way to call LLMs and automatically invoke tools. You can use the pre-built Arcade Google toolkit to quickly build agents and AI apps that interact with Google services like Gmail, Calendar, Drive, and more.

If the pre-built tools in the Google toolkit don't meet your needs, you can author your own custom tools that interact with Google APIs.

Use the Google() auth class to specify that a tool requires authorization with Google. The context.authorization.token field will be automatically populated with the user's Google token:

from typing import Annotated
 
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import Google
 
from google.oauth2.credentials import Credentials
from googleapiclient.discovery import build
 
 
@tool(
    requires_auth=Google(
        scopes=["https://www.googleapis.com/auth/gmail.send"],
    )
)
async def send_email(
    context: ToolContext,
    subject: Annotated[str, "The subject of the email"],
    body: Annotated[str, "The body of the email"],
    recipient: Annotated[str, "The recipient of the email"],
) -> Annotated[str, "A confirmation message with the sent email ID and URL"]:
    """
    Send an email using the Gmail API.
    """
 
    # Set up the Gmail API client
    service = build("gmail", "v1", credentials=Credentials(context.authorization.token))