Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Google Drive connector

OAuth 2.0 Files & Documents

Connect to Google Drive. Manage files, folders, and sharing permissions

Google Drive connector

  1. Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Register your Google Drive credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

    Dashboard setup steps

    Register your Scalekit environment with the Google Drive connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

    1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Google Drive and click Create. Click Use your own credentials and copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        Copy redirect URI from Scalekit dashboard

      • Navigate to Google Cloud ConsoleAPIs & ServicesCredentials. Select + Create Credentials, then OAuth client ID. Choose Web application from the Application type menu.

        Select Web Application in Google OAuth settings

      • Under Authorized redirect URIs, click + Add URI, paste the redirect URI, and click Create.

        Add authorized redirect URI in Google Cloud Console

    2. Enable the Google Drive API

      • In Google Cloud Console, go to APIs & ServicesLibrary. Search for “Google Drive API” and click Enable.
    3. Get client credentials

      • Google provides your Client ID and Client Secret after you create the OAuth client ID in step 1.
    4. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.

      • Enter your credentials:

        Add credentials in Scalekit dashboard

      • Click Save.

  4. quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENV_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'googledrive'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Google Drive:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'googledrive_query_drive_activity',
    toolInput: {},
    })
    console.log(result)

Connect this agent connector to let your agent:

  • File share, move, copy — Share a file or folder in Google Drive by creating a new permission for a user, group, domain, or anyone
  • Query drive activity — Query Google Drive activity to see who viewed, edited, moved, or shared files
  • Delete file — Permanently delete a file or folder in Google Drive by its file ID
  • Create folder — Create a new folder in Google Drive
  • Search files, content — Search for files and folders in Google Drive using query filters like name, type, owner, and parent folder
  • Get file metadata — Retrieve metadata for a specific file in Google Drive by its file ID
Proxy API call
const result = await actions.request({
connectionName: 'googledrive',
identifier: 'user_123',
path: '/drive/v3/files',
method: 'GET',
});
console.log(result);
Download a file

Download a file from Google Drive by its file ID via the Scalekit proxy.

file_id = "<YOUR_FILE_ID>" # file ID from Drive (visible in the file's URL)
output_path = "downloaded.pdf"
response = actions.request(
connection_name='googledrive',
identifier='user_123',
path=f"/drive/v3/files/{file_id}",
method="GET",
query_params={"alt": "media"},
)
with open(output_path, "wb") as f:
f.write(response.content)
print(f"Downloaded: {output_path} ({len(response.content):,} bytes)")
Upload a file

Upload a file to Google Drive via the Scalekit proxy. Scalekit injects the OAuth token automatically — your app never handles credentials directly.

import mimetypes
file_path = "report.pdf"
file_name = "report.pdf"
with open(file_path, "rb") as f:
file_bytes = f.read()
mime_type = mimetypes.guess_type(file_path)[0] or "application/octet-stream"
response = actions.request(
connection_name='googledrive',
identifier='user_123',
path="/upload/drive/v3/files",
method="POST",
query_params={"uploadType": "media", "name": file_name},
form_data=file_bytes,
headers={"Content-Type": mime_type},
)
file_id = response.json()["id"]
print(f"Uploaded: {file_name} (File ID: {file_id})")
googledrive_get_file_metadata

Retrieve metadata for a specific file in Google Drive by its file ID. Returns name, MIME type, size, creation time, and more.

NameTypeRequiredDescription
fieldsstringNoFields to include in the response
file_idstringYesThe ID of the file to retrieve metadata for
schema_versionstringNoOptional schema version to use for tool execution
supports_all_drivesbooleanNoSupport shared drives
tool_versionstringNoOptional tool version to use for execution
googledrive_search_content

Search inside the content of files stored in Google Drive using full-text search. Finds files where the body text matches the search term.

NameTypeRequiredDescription
fieldsstringNoFields to include in the response
mime_typestringNoFilter results by MIME type
page_sizeintegerNoNumber of files to return per page
page_tokenstringNoToken for the next page of results
schema_versionstringNoOptional schema version to use for tool execution
search_termstringYesText to search for inside file contents
supports_all_drivesbooleanNoInclude shared drives in results
tool_versionstringNoOptional tool version to use for execution
googledrive_search_files

Search for files and folders in Google Drive using query filters like name, type, owner, and parent folder.

NameTypeRequiredDescription
fieldsstringNoFields to include in the response
order_bystringNoSort order for results
page_sizeintegerNoNumber of files to return per page
page_tokenstringNoToken for the next page of results
querystringNoDrive search query string
schema_versionstringNoOptional schema version to use for tool execution
supports_all_drivesbooleanNoInclude shared drives in results
tool_versionstringNoOptional tool version to use for execution
Execute a tool
const result = await actions.executeTool({
connector: 'googledrive',
identifier: 'user_123',
toolName: 'googledrive_get_file_metadata',
toolInput: {},
});
console.log(result);

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

googledrive_copy_file # Create a copy of an existing file in Google Drive. Optionally rename the copy, place it in a different folder, or add a description. Uses OAuth credentials. 6 params

Create a copy of an existing file in Google Drive. Optionally rename the copy, place it in a different folder, or add a description. Uses OAuth credentials.

Name Type Required Description
file_id string required ID of the file to copy
description string optional Optional description for the copied file
name string optional Name for the copied file. If omitted, the copy is named 'Copy of <original name>'.
parent_folder_id string optional ID of the destination folder for the copy. If omitted, the copy is placed in the same folder as the original.
schema_version string optional Optional schema version to use for tool execution
tool_version string optional Optional tool version to use for execution
googledrive_create_folder # Create a new folder in Google Drive. Optionally place it inside a parent folder and add a description. Uses OAuth credentials. 5 params

Create a new folder in Google Drive. Optionally place it inside a parent folder and add a description. Uses OAuth credentials.

Name Type Required Description
name string required Name of the new folder
description string optional Optional description for the new folder
parent_folder_id string optional ID of the parent folder to create this folder inside. If omitted, the folder is created in the root of My Drive.
schema_version string optional Optional schema version to use for tool execution
tool_version string optional Optional tool version to use for execution
googledrive_delete_file # Permanently delete a file or folder in Google Drive by its file ID. This action cannot be undone. Uses OAuth credentials. 4 params

Permanently delete a file or folder in Google Drive by its file ID. This action cannot be undone. Uses OAuth credentials.

Name Type Required Description
file_id string required ID of the file or folder to delete
schema_version string optional Optional schema version to use for tool execution
supports_all_drives boolean optional Whether the request supports files in shared drives
tool_version string optional Optional tool version to use for execution
googledrive_get_file_metadata # Retrieve metadata for a specific file in Google Drive by its file ID. Returns name, MIME type, size, creation time, and more. 5 params

Retrieve metadata for a specific file in Google Drive by its file ID. Returns name, MIME type, size, creation time, and more.

Name Type Required Description
file_id string required The ID of the file to retrieve metadata for
fields string optional Fields to include in the response
schema_version string optional Optional schema version to use for tool execution
supports_all_drives boolean optional Support shared drives
tool_version string optional Optional tool version to use for execution
googledrive_move_file # Move a file or folder to a different location in Google Drive by updating its parent folder. Optionally rename the file during the move. Uses OAuth credentials. 6 params

Move a file or folder to a different location in Google Drive by updating its parent folder. Optionally rename the file during the move. Uses OAuth credentials.

Name Type Required Description
file_id string required ID of the file or folder to move
new_parent_id string required ID of the destination folder to move the file into
name string optional Optional new name for the file after moving. If omitted, the file keeps its current name.
old_parent_id string optional ID of the current parent folder to remove the file from. Providing this ensures a clean move without the file appearing in multiple folders.
schema_version string optional Optional schema version to use for tool execution
tool_version string optional Optional tool version to use for execution
googledrive_query_drive_activity # Query Google Drive activity to see who viewed, edited, moved, or shared files. Useful for auditing and compliance. Uses OAuth credentials. 8 params

Query Google Drive activity to see who viewed, edited, moved, or shared files. Useful for auditing and compliance. Uses OAuth credentials.

Name Type Required Description
ancestor_name string optional Restrict activity to items under this folder. Format: 'items/FOLDER_ID'. Example: 'items/0B_abc123xyz'
consolidation_strategy string optional How related activity is grouped. 'none' means each action is its own activity; 'legacy' consolidates similar actions. Valid values: 'none', 'legacy'.
filter string optional Filter string to narrow activity results. Example: "time >= \"2026-01-01T00:00:00Z\""
item_name string optional Restrict activity to a specific file or folder. Format: 'items/FILE_ID'. Example: 'items/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms'
page_size integer optional Maximum number of activity records to return per page. Max 100.
page_token string optional Token for the next page of results from a previous response.
schema_version string optional Optional schema version to use for tool execution
tool_version string optional Optional tool version to use for execution
googledrive_search_content # Search inside the content of files stored in Google Drive using full-text search. Finds files where the body text matches the search term. 8 params

Search inside the content of files stored in Google Drive using full-text search. Finds files where the body text matches the search term.

Name Type Required Description
search_term string required Text to search for inside file contents
fields string optional Fields to include in the response
mime_type string optional Filter results by MIME type
page_size integer optional Number of files to return per page
page_token string optional Token for the next page of results
schema_version string optional Optional schema version to use for tool execution
supports_all_drives boolean optional Include shared drives in results
tool_version string optional Optional tool version to use for execution
googledrive_search_files # Search for files and folders in Google Drive using query filters like name, type, owner, and parent folder. 8 params

Search for files and folders in Google Drive using query filters like name, type, owner, and parent folder.

Name Type Required Description
fields string optional Fields to include in the response
order_by string optional Sort order for results
page_size integer optional Number of files to return per page
page_token string optional Token for the next page of results
query string optional Drive search query string
schema_version string optional Optional schema version to use for tool execution
supports_all_drives boolean optional Include shared drives in results
tool_version string optional Optional tool version to use for execution
googledrive_share_file # Share a file or folder in Google Drive by creating a new permission for a user, group, domain, or anyone. Supports sending notification emails. Uses OAuth credentials. 10 params

Share a file or folder in Google Drive by creating a new permission for a user, group, domain, or anyone. Supports sending notification emails. Uses OAuth credentials.

Name Type Required Description
file_id string required ID of the file or folder to share
role string required The role to grant to the recipient. One of: 'reader', 'commenter', 'writer', 'organizer', 'fileOrganizer', 'owner'.
type string required The type of principal to share with. One of: 'user', 'group', 'domain', 'anyone'.
domain string optional The domain to share with. Required when type is 'domain'. Example: 'example.com'.
email_address string optional Email address of the user or group to share with. Required when type is 'user' or 'group'. Example: 'user@example.com'.
email_message string optional Custom message to include in the notification email sent to the recipient.
schema_version string optional Optional schema version to use for tool execution
send_notification_email boolean optional Whether to send a notification email to the recipient. Defaults to true.
tool_version string optional Optional tool version to use for execution
transfer_ownership boolean optional Whether to transfer ownership of the file to the recipient. Only valid when role is 'owner'.