Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Kickbox

Scalekit connector
Open markdown

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

Tools
3
What they doRead · write · destructive
2 · 1 · 02 read1 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 Kickbox connection

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

    Each user opens the link once and enters their Kickbox 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
  • kickbox_batch_verify_getGet the status of a Kickbox batch verification job and, once complete, its results link.Read-only

    Get Batch Verification

    Get the status of a Kickbox batch verification job and, once complete, its results link. Returns id, status (starting, processing, completed or failed), progress counts while processing, and when completed name, stats (deliverable, undeliverable, risky, unknown, sendex, addresses), download_url, created_at, duration and error. Use kickbox_batch_verify_get to poll a batch job started in the Kickbox app or the Kickbox batch API. Use kickbox_email_verify to verify one address. The download_url is valid for one hour; call again for a fresh one. Requires the numeric job id that Kickbox returned when the job was started.

    Inputs

    job_idintegerrequired
    ID of the batch job, as returned by Kickbox when the job was started. Example: 123.
  • kickbox_disposable_checkCheck whether an email address or domain belongs to a known disposable (temporary) email provider.Read-only

    Check Disposable Domain

    Check whether an email address or domain belongs to a known disposable (temporary) email provider. Free; spends no credits. Returns disposable (true or false). Use kickbox_disposable_check for a quick, free disposable check. Use kickbox_email_verify for a full deliverability check.

    Inputs

    addressstringrequired
    The email address or bare domain to check. Example: mailinator.com.
  • kickbox_email_verifyVerify one email address in real time and spend one Kickbox verification credit (sandbox keys spend none).Write

    Verify Email

    Verify one email address in real time and spend one Kickbox verification credit (sandbox keys spend none). Returns result (deliverable, undeliverable, risky or unknown), reason, role, free, disposable, accept_all, did_you_mean, sendex quality score, email, user and domain, plus threat_score when requested. Use kickbox_email_verify for one address at a time, such as at sign-up. Use kickbox_disposable_check for a free disposable-domain check only. Keep timeout at 8000 ms or less so the call finishes inside the tool-call time limit.

    • Idempotent

    Inputs

    emailstringrequired
    The email address to verify. Example: bill.lumbergh@gamil.com.
    include_threatboolean
    Set true to also return a Threat Score (threat_score and threat_level) for the address. Threat Score must be enabled on the Kickbox account; otherwise it is ignored. Costs one extra credit only when a threat signal is found. Do not combine with threat_only. Example: true.
    threat_onlyboolean
    Set true to return only the Threat Score, without a standard verification; the usual result fields are then not populated. Threat Score must be enabled on the account. Do not combine with include_threat. Example: true.
    timeoutinteger
    Longest time in milliseconds Kickbox may spend on the verification, up to 30000. Kickbox's default is 6000. Use 8000 or less to stay within the tool-call time limit. Example: 6000.