Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Perigon

Scalekit connector
Open markdown

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

Tools
50
What they doRead · write · destructive
35 · 11 · 435 read11 write4 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 Perigon connection

    In AgentKit > Connections, create a Perigon 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 = 'perigon'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Perigon:', 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: 'perigon_articles_search',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Perigon 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
  • perigon_articles_refresh_job_getGet the status and results of an article refresh job.Read-only

    Get Article Refresh Job

    Get the status and results of an article refresh job. Returns jobId, status and results with each article's articleId, status, reason, data and computedAt. Use after perigon_articles_refresh_job_create.

    Inputs

    idstringrequired
    Job id returned by perigon_articles_refresh_job_create. Example: rj_3f1c7b9e2a4d4e8f.
  • perigon_articles_refresh_peekRead whatever refreshed article data is already cached for some article IDs, without starting a refresh.Read-only

    Peek Refreshed Articles

    Read whatever refreshed article data is already cached for some article IDs, without starting a refresh. Returns results with any cached refreshed data and its fetchedAt and validatedAt times. Use perigon_articles_refresh_job_create to request a refresh.

    Inputs

    article_idsarrayrequired
    articleId values to look up. Example: ["8f1e2d3c4b5a69788776655443322110"]
  • perigon_contact_point_getGet one contact point.Read-only

    Get Contact Point

    Get one contact point. Returns data with the contact point's uuid, type, status, name, email or webhookUrl and verified. Use perigon_contact_points_list to find UUIDs.

    Inputs

    uuidstringrequired
    UUID of the contact point. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
  • perigon_contact_points_listList the notification contact points (email and webhook destinations) in your organization.Read-only

    List Contact Points

    List the notification contact points (email and webhook destinations) in your organization. Returns total and data with each contact point's uuid, type, status, name, email or webhookUrl and verified. Use contact point UUIDs in perigon_monitor_create.

    Inputs

    pageinteger
    Zero-based page number to retrieve. Defaults to 0. Example: 10.
    sizeinteger
    Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
    sort_bystring
    Field to sort by: createdAt or updatedAt. Defaults to createdAt. Example: createdAt.one of createdAtupdatedAtdefault createdAt
    sort_orderstring
    Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc.one of ascdescdefault desc
    statusarray
    Only items with these statuses. Example: ACTIVE.
    typearray
    Only contact points of these types. Example: EMAIL.
  • perigon_journalist_getGet one journalist's profile.Read-only

    Get Journalist

    Get one journalist's profile. Returns id, name, fullName, headline, description, title, locations, topTopics, topSources and social handles. Use a journalist id from perigon_journalists_search or an article's authors.

    Inputs

    idstringrequired
    Journalist id. Example: 4bd0e2c7-8f6a-4a3b-9c1d-2e3f4a5b6c7d.