Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Seismic

Scalekit connector
Open markdown

The Seismic connector lets your AI agent act in each user's Seismic account. Each user signs in to Seismic once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 45 tools.

Tools
45
What they doRead · write · destructive
25 · 20 · 025 read20 write0 destructive
Users sign in with
OAuth app
Your own Seismic app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv

  2. Set your credentials

    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. Create the Seismic connection

    In AgentKit > Connections, create a Seismic connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Seismic connections use your own OAuth app. Register one with Seismic and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Seismic connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENVIRONMENT_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'seismic'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Seismic:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'seismic_generative_search',
      toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • seismic_download_library_fileDownload the latest binary content of a Seismic Library file in the specified teamsite.Read-only

    Download Library File

    Download the latest binary content of a Seismic Library file in the specified teamsite. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true to have the API respond with a 302 redirect containing the temporary download link in the Location header (for clients that can follow redirects and stream directly); set redirect=false (default) to instead get a 200 response whose body contains a temporary download URL, for custom transfer or deferred-download handling. Do not use this to download a specific historical version — use the version-pinned download endpoint instead.

    Inputs

    libraryContentIdstringrequired
    Identifier of the Library file whose binary content you want to download. Must identify file content (not folder/URL); must be a UUID.
    teamsiteIdstringrequired
    Identifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.
    redirectboolean
    Controls response mode. When true, the API responds with 302 and returns the temporary download link in the Location header. When false (default), the API responds with 200 and returns a temporary download URL in the response body.default false

    Also accepts schema_version and tool_version to pin a version.

  • seismic_download_livedoc_outputDownload a particular generated Document Generator (LiveDoc) output file, such as .pptx, .docx, .pdf, or .xlsx.Read-only

    Download LiveDoc Output

    Download a particular generated Document Generator (LiveDoc) output file, such as .pptx, .docx, .pdf, or .xlsx. Returns raw file bytes (application/octet-stream), not JSON. Supports the special outputId alias keywords 'pptx', 'docx', 'pdf', 'gslides', and 'gdoc' so callers can download without first looking up the generated outputId. Set redirect=true (default) to have the API respond with a 302 redirect to the download URL; set redirect=false to instead get a 200 response with a JSON body containing the download URL. Confirm the LiveDoc generation is complete before calling this; do not use it to start generation or check status.

    Inputs

    generatedLivedocIdstringrequired
    Identifier of the generated LiveDoc job that contains the output to download.
    outputIdstringrequired
    Output identifier for the specific generated file, or an alias keyword: pptx, docx, pdf, gslides, or gdoc.
    redirectboolean
    Controls response mode. When true (default), the API responds with 302 and redirects to the output's temporary download URL. When false, the API responds with 200 and returns the temporary download URL in the response body.default true

    Also accepts schema_version and tool_version to pin a version.

  • seismic_download_workspace_fileDownload the binary content of a file from the authenticated user's personal Seismic workspace.Read-only

    Download Workspace File

    Download the binary content of a file from the authenticated user's personal Seismic workspace. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true (default) to have the API respond with a 302 redirect to the file's download URL, for clients that can follow redirects; set redirect=false to instead get a 200 response with a JSON body containing the download URL. This is a read-only operation and does not modify server state. Do not use this to fetch file metadata or Library content.

    Inputs

    workspaceContentIdstringrequired
    The unique identifier of the workspace file whose binary content to download.
    redirectboolean
    Controls response mode. When true (default), the API responds with 302 and redirects to the file's temporary download URL. When false, the API responds with 200 and returns the temporary download URL in the response body.default true

    Also accepts schema_version and tool_version to pin a version.

  • seismic_get_generated_livedoc_statusRetrieve the current status of a LiveDoc generation job, including the overall status and a per-output breakdown of readiness (for example, a PPTX output may be ready for download while a PDF output is still generating).Read-only

    Get Generated LiveDoc Status

    Retrieve the current status of a LiveDoc generation job, including the overall status and a per-output breakdown of readiness (for example, a PPTX output may be ready for download while a PDF output is still generating). Poll this after calling generate-livedoc and before attempting to download outputs.

    Inputs

    generatedLivedocIdstringrequired
    Identifier of the generated LiveDoc job to check, returned by the generate-livedoc call.

    Also accepts schema_version and tool_version to pin a version.

  • seismic_get_library_urlRetrieve the current metadata and properties for a URL content item stored in the Seismic Library, identified by libraryContentId within the specified teamsite.Read-only

    Get Library URL

    Retrieve the current metadata and properties for a URL content item stored in the Seismic Library, identified by libraryContentId within the specified teamsite. The response includes ownership, versioning, profile assignments, custom properties, expert associations, and the target URL details. Only call when libraryContentId is known to resolve to a URL item; use the generic item-info endpoint if the content type is uncertain.

    Inputs

    libraryContentIdstringrequired
    Identifier of the Library URL content item to retrieve metadata for. Must be a UUID.
    teamsiteIdstringrequired
    Teamsite identifier that scopes the request to one teamsite context. May be the literal value '1' or a GUID-formatted string.

    Also accepts schema_version and tool_version to pin a version.

  • seismic_get_teamsiteReturns metadata for a single Seismic teamsite identified by teamsiteId, including its display name and whether it is the tenant default teamsite.Read-only

    Get Teamsite

    Returns metadata for a single Seismic teamsite identified by teamsiteId, including its display name and whether it is the tenant default teamsite. Use `1` for the tenant default teamsite or a UUID for a custom teamsite.

    Inputs

    teamsiteIdstringrequired
    Teamsite identifier to retrieve. Use `1` for the tenant default teamsite or a UUID for a custom teamsite.

    Also accepts schema_version and tool_version to pin a version.

All 64 in CRM & Sales