Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Faraday

Scalekit connector
Open markdown

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

Tools
58
What they doRead · write · destructive
34 · 19 · 534 read19 write5 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 Faraday connection

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

    Each user opens the link once and enters their Faraday 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
  • faraday_account_getGet the account the API key belongs to.Read-only

    Get Current Account

    Get the account the API key belongs to. Returns the account with id, name and settings. Use faraday_account_get to check the connection.

    Inputs

    This tool takes no inputs.

  • faraday_attributes_listList the Faraday Identity Graph attributes available for cohorts, persona sets and outcomes.Read-only

    List Attributes

    List the Faraday Identity Graph attributes available for cohorts, persona sets and outcomes. Returns an array of attributes with name, literate, category and type. Use faraday_attributes_list to pick attribute names such as fdy/age for cohort filters.

    Inputs

    idsstring
    Comma-separated IDs to return only those records. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_cohort_getGet one cohort by UUID.Read-only

    Get Cohort

    Get one cohort by UUID. Returns the cohort with its configuration, status and build details. Use faraday_cohort_get to check whether it is ready.

    Inputs

    cohort_idstringrequired
    UUID of the cohort. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_cohort_membership_getGet a cohort's membership counts over time.Read-only

    Get Cohort Membership

    Get a cohort's membership counts over time. Returns membership statistics. Use faraday_cohort_membership_get to see how large a cohort is.

    Inputs

    cohort_idstringrequired
    UUID of the cohort. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_cohorts_listList the account's cohorts (groups of people defined by stream events, traits or attributes).Read-only

    List Cohorts

    List the account's cohorts (groups of people defined by stream events, traits or attributes). Returns an array of cohorts with id, name, population count and status. Use faraday_cohorts_list to find a cohort ID for outcomes, persona sets and scopes.

    Inputs

    idsstring
    Comma-separated IDs to return only those records. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_connection_getGet one connection by UUID.Read-only

    Get Connection

    Get one connection by UUID. Returns the connection with type and status (secrets are not returned). Use faraday_connection_get to check a connection.

    Inputs

    connection_idstringrequired
    UUID of the connection. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_connections_listList the account's data connections (warehouses, buckets, CRMs).Read-only

    List Connections

    List the account's data connections (warehouses, buckets, CRMs). Returns an array of connections with id, name, type and status. Use faraday_connections_list to get a connection_id for datasets and targets.

    Inputs

    idsstring
    Comma-separated IDs to return only those records. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.
  • faraday_dataset_getGet one dataset by UUID.Read-only

    Get Dataset

    Get one dataset by UUID. Returns the dataset with its configuration, status and build details. Use faraday_dataset_get to check whether it is ready.

    Inputs

    dataset_idstringrequired
    UUID of the dataset. Example: 4f8a2c1e-7b3d-4e9a-8c6f-1d2e3f4a5b6c.