Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Bouncer

Scalekit connector
Open markdown

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

Tools
13
What they doRead · write · destructive
5 · 6 · 25 read6 write2 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 Bouncer connection

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

    Each user opens the link once and enters their Bouncer 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
  • bouncer_batch_results_getDownload the results of a completed verification batch, optionally only one result status.Read-only

    Get Batch Results

    Download the results of a completed verification batch, optionally only one result status. Returns a list of email records, each with status, reason, domain and account flags, score and toxicity. Use this once bouncer_batch_status_get reports completed.

    Inputs

    batch_idstringrequired
    Batch ID returned by bouncer_batch_create. Example: 61f1e8d1c3a2b4001234abcd.
    downloadstring
    Which results to download: all, deliverable, risky, undeliverable or unknown. Defaults to all. Example: deliverable.one of alldeliverableriskyundeliverableunknown
  • bouncer_batch_status_getGet the status of a verification batch.Read-only

    Get Batch Status

    Get the status of a verification batch. Returns status (queued, processing or completed), counts and, with with_stats, result statistics. Use this to poll a batch from bouncer_batch_create. Use bouncer_batch_results_get when it is completed.

    Inputs

    batch_idstringrequired
    Batch ID returned by bouncer_batch_create. Example: 61f1e8d1c3a2b4001234abcd.
    with_statsboolean
    Include processing statistics (counts per result status). Defaults to false. Example: true.
  • bouncer_credits_getGet the Bouncer account's available verification credits.Read-only

    Get Credits

    Get the Bouncer account's available verification credits. Returns the credits balance. Use this before large batches, or to confirm the connection works.

    Inputs

    This tool takes no inputs.

  • bouncer_toxicity_list_results_getDownload the results of a completed toxicity check.Read-only

    Get Toxicity Check Results

    Download the results of a completed toxicity check. Returns each email with its toxicity score from 0 (safe) to 5 (very toxic). Use this once bouncer_toxicity_list_status_get reports completed.

    Inputs

    idstringrequired
    Toxicity list job ID returned by bouncer_toxicity_list_create. Example: 61f1e8d1c3a2b4001234abce.
  • bouncer_toxicity_list_status_getGet the status of a toxicity check job.Read-only

    Get Toxicity Check Status

    Get the status of a toxicity check job. Returns the job id and status. Use bouncer_toxicity_list_results_get when it is completed.

    Inputs

    idstringrequired
    Toxicity list job ID returned by bouncer_toxicity_list_create. Example: 61f1e8d1c3a2b4001234abce.
  • bouncer_batch_createSubmit a list of email addresses (up to 100,000; 1,000 to 10,000 recommended) for asynchronous verification.Write

    Create Batch

    Submit a list of email addresses (up to 100,000; 1,000 to 10,000 recommended) for asynchronous verification. Uses one credit per address. Returns the batchId, its status and the number of emails queued. Use this for lists. Poll bouncer_batch_status_get until completed, then read bouncer_batch_results_get.

    Inputs

    emailsarrayrequired
    Email addresses to verify. Example: ["jane@example.com", "john@example.com"]
    callbackstring
    URL Bouncer calls when the batch is finished. Example: https://example.com/hooks/bouncer.
  • bouncer_batch_finishStop a running batch early: emails not yet verified are skipped and their credits returned.Write

    Finish Batch

    Stop a running batch early: emails not yet verified are skipped and their credits returned. Returns a confirmation. Download what was verified with bouncer_batch_results_get once bouncer_batch_status_get reports completed.

    • Idempotent

    Inputs

    batch_idstringrequired
    Batch ID returned by bouncer_batch_create. Example: 61f1e8d1c3a2b4001234abcd.
  • bouncer_batch_sync_verifyVerify up to 10,000 email addresses through the batch queue and wait for the results in the same call.Write

    Verify Emails (Batch Sync)

    Verify up to 10,000 email addresses through the batch queue and wait for the results in the same call. Uses one credit per address (results are reused for 24 hours). Returns a list of email records with status, reason, domain and account flags, score and toxicity. Use this for small lists when you want results in one call; it can take a long time. Use bouncer_batch_create for large lists.

    Inputs

    emailsarrayrequired
    Email addresses to verify, at most 10,000. Example: ["jane@example.com", "john@example.com"]