Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Google Docs connector

OAuth 2.0 filesdocuments

Connect to Google Docs. Create, edit, and collaborate on documents

Google Docs 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 Docs 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 Docs 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 Docs 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 Docs API

      • In Google Cloud Console, go to APIs & ServicesLibrary. Search for “Google Docs 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 = 'googledocs'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Google Docs:', 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: 'googledocs_list_documents',
    toolInput: {},
    })
    console.log(result)

Connect this agent connector to let your agent:

  • List documents — List all Google Docs documents in the user’s Drive
  • Update document — Update the content of an existing Google Doc using batch update requests
  • Read document — Read the complete content and structure of a Google Doc including text, formatting, tables, and metadata
  • Create document — Create a new blank Google Doc with an optional title
Proxy API call
const result = await actions.request({
connectionName: 'googledocs',
identifier: 'user_123',
path: '/v1/documents/<DOCUMENT_ID>',
method: 'GET',
});
console.log(result);
googledocs_create_document

Create a new blank Google Doc with an optional title. Returns the new document’s ID and metadata.

NameTypeRequiredDescription
schema_versionstringNoOptional schema version to use for tool execution
titlestringNoTitle of the new document
tool_versionstringNoOptional tool version to use for execution
googledocs_read_document

Read the complete content and structure of a Google Doc including text, formatting, tables, and metadata.

NameTypeRequiredDescription
document_idstringYesThe ID of the Google Doc to read
schema_versionstringNoOptional schema version to use for tool execution
suggestions_view_modestringNoHow suggestions are rendered in the response
tool_versionstringNoOptional tool version to use for execution
googledocs_update_document

Update the content of an existing Google Doc using batch update requests. Supports inserting and deleting text, formatting, tables, and other document elements.

NameTypeRequiredDescription
document_idstringYesThe ID of the Google Doc to update
requestsarray<object>YesArray of update requests to apply to the document
schema_versionstringNoOptional schema version to use for tool execution
tool_versionstringNoOptional tool version to use for execution
write_controlobjectNoOptional write control for revision management
Execute a tool
const result = await actions.executeTool({
connector: 'googledocs',
identifier: 'user_123',
toolName: 'googledocs_create_document',
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.

googledocs_create_document # Create a new blank Google Doc with an optional title. Returns the new document's ID and metadata. 3 params

Create a new blank Google Doc with an optional title. Returns the new document's ID and metadata.

Name Type Required Description
schema_version string optional Optional schema version to use for tool execution
title string optional Title of the new document
tool_version string optional Optional tool version to use for execution
googledocs_list_documents # List all Google Docs documents in the user's Drive. Optionally search by document name. Returns document IDs, names, and metadata with pagination support. 4 params

List all Google Docs documents in the user's Drive. Optionally search by document name. Returns document IDs, names, and metadata with pagination support.

Name Type Required Description
order_by string optional Sort order for results. Examples: modifiedTime desc, name asc, createdTime desc
page_size integer optional Number of documents to return per page (max 1000, default 100)
page_token string optional Token for retrieving the next page of results. Use the nextPageToken from a previous response.
query string optional Drive search query to filter documents. Defaults to all Google Docs. To search by name, use: mimeType = 'application/vnd.google-apps.document' and trashed = false and name contains 'report'
googledocs_read_document # Read the complete content and structure of a Google Doc including text, formatting, tables, and metadata. 4 params

Read the complete content and structure of a Google Doc including text, formatting, tables, and metadata.

Name Type Required Description
document_id string required The ID of the Google Doc to read
schema_version string optional Optional schema version to use for tool execution
suggestions_view_mode string optional How suggestions are rendered in the response
tool_version string optional Optional tool version to use for execution
googledocs_update_document # Update the content of an existing Google Doc using batch update requests. Supports inserting and deleting text, formatting, tables, and other document elements. 5 params

Update the content of an existing Google Doc using batch update requests. Supports inserting and deleting text, formatting, tables, and other document elements.

Name Type Required Description
document_id string required The ID of the Google Doc to update
requests array required Array of update requests to apply to the document
schema_version string optional Optional schema version to use for tool execution
tool_version string optional Optional tool version to use for execution
write_control object optional Optional write control for revision management