Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Linkup

Scalekit connector
Open markdown

The Linkup connector lets your AI agent act in each user's Linkup account. Each user connects their own Linkup access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 11 tools.

Tools
11
What they doRead · write · destructive
9 · 2 · 09 read2 write0 destructive
Users sign in with

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 Linkup connection

    In AgentKit > Connections, create a Linkup connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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 = 'linkup'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Linkup:', 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: 'linkup_credits_balance_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Linkup credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • linkup_credits_balance_getGet the remaining credit balance of your Linkup account.Read-only

    Get Credits Balance

    Get the remaining credit balance of your Linkup account. Returns the balance. Use this before large batches or deep searches to check you have credits.

    Inputs

    This tool takes no inputs.

  • linkup_page_fetchFetch one public web page or PDF by URL and return its content as clean markdown, optionally with typed JSON extracted by a schema.Read-only

    Fetch Web Page

    Fetch one public web page or PDF by URL and return its content as clean markdown, optionally with typed JSON extracted by a schema. Returns markdown, and when requested raw content, images or the structured object. Use this when you already know the URL. Use linkup_search to find pages first.

    Inputs

    urlstringrequired
    Full URL of the public page or PDF to fetch. Example: https://www.linkup.so/blog.
    extract_imagesboolean
    Also return the images found on the page. Linkup defaults to false. Example: false.
    include_raw_contentboolean
    Also return the raw page content and its content type. Linkup defaults to false. Example: false.
    instructionsstring
    Instructions that guide the structured extraction. Requires schema. Example: Extract the article title and publication date.
    modestring
    Fetch strategy. pro has much higher success on hard-to-retrieve pages and costs more. Linkup defaults to standard. Example: standard.one of standardpro
    render_jsboolean
    Render the page's JavaScript before extracting. Slower; use for single-page apps. Linkup defaults to false. Example: false.
    schemastring
    JSON Schema, as a string, of type object describing structured data to extract from the page. Fields with no grounded value are left out. Example: {"type":"object","properties":{"title":{"type":"string"}}}
  • linkup_research_getGet one research task by id, with its status and, once completed, its answer or structured output and sources.Read-only

    Get Research Task

    Get one research task by id, with its status and, once completed, its answer or structured output and sources. Returns the task id, status (pending, processing, completed or failed) and output. Use this to poll a task started by linkup_research_create. Use linkup_research_list to find task ids.

    Inputs

    idstringrequired
    Research task id returned by linkup_research_create or linkup_research_list. Example: 6f1c2a9e-3b4d-4e5f-8a7b-1c2d3e4f5a6b.
  • linkup_research_listList the research tasks created by your Linkup organization, with pagination.Read-only

    List Research Tasks

    List the research tasks created by your Linkup organization, with pagination. Returns tasks with their id, status and timestamps. Use this to find a research task id. Use linkup_research_get for one task's output.

    Inputs

    pageinteger
    Page number, starting at 1. Linkup defaults to 1. Example: 1.
    page_sizeinteger
    Results per page, 1 to 100. Linkup defaults to 10. Example: 20.
    sort_bystring
    Field to sort by. Example: createdAt.one of createdAtupdatedAt
    sort_directionstring
    Sort direction. Linkup defaults to asc. Example: desc.one of ascdesc
  • linkup_rewind_fetchReturn a web page as it was at the end of a given UTC day (beta).Read-only

    Fetch Past Page (Rewind)

    Return a web page as it was at the end of a given UTC day (beta). Returns the stored page content for that day. Use this to see a page's past version. The URL must match the stored URL exactly. Use linkup_page_fetch for the live page.

    Inputs

    as_ofstringrequired
    UTC day to fetch the page as of, YYYY-MM-DD. Example: 2025-09-17.
    urlstringrequired
    Exact URL of the page. No normalization is applied, so it must match the stored URL. Example: https://www.federalreserve.gov/newsevents/pressreleases.htm.
  • linkup_task_getGet one batch task by id, with its type, status and, once completed, its output.Read-only

    Get Batch Task

    Get one batch task by id, with its type, status and, once completed, its output. Returns the task id, type, status and output. Use this to poll a task created by linkup_tasks_create. Use linkup_tasks_list to find ids.

    Inputs

    idstringrequired
    Task id returned by linkup_tasks_create or linkup_tasks_list. Example: 6f1c2a9e-3b4d-4e5f-8a7b-1c2d3e4f5a6b.