Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to CallerAPI

Scalekit connector
Open markdown

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

Tools
26
What they doRead · write · destructive
16 · 8 · 216 read8 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 CallerAPI connection

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

    Each user opens the link once and enters their CallerAPI 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
  • callerapi_account_getGet the CallerAPI account's email and credit balance.Read-only

    Get Account Balance

    Get the CallerAPI account's email and credit balance. Returns email, status, credits_left, credits_monthly and credits_spent. Use this to check remaining credits before running paid lookups such as callerapi_phone_lookup or callerapi_phone_kyc_verify.

    Inputs

    This tool takes no inputs.

  • callerapi_did_number_getGet the result of the last spam-label check for one monitored phone number.Read-only

    Get Monitored Number

    Get the result of the last spam-label check for one monitored phone number. Returns phone, status, label, status_changed_at, last_checked_at and next_check_at. Use callerapi_did_numbers_list to browse all numbers. Does not run a new check or use credits.

    Inputs

    phonestringrequired
    The monitored number in E.164 format. Example: +18883101970.
  • callerapi_did_numbers_listList the phone numbers (DIDs) in DID monitoring with the result of their last spam-label check, one page at a time.Read-only

    List Monitored Numbers

    List the phone numbers (DIDs) in DID monitoring with the result of their last spam-label check, one page at a time. Returns numbers with phone, status (pending, clean, flagged, unknown), label, status_changed_at, last_checked_at and next_check_at, plus next_cursor for the next page. Use this to review all monitored numbers. Use callerapi_did_number_get for one number. Does not use credits.

    Inputs

    cursorstring
    The next_cursor value from the previous page. Keep the same status and list_id for every page. Example: eyJpZCI6MTIzfQ.
    limitinteger
    Numbers per page. Default 50, maximum 100. Example: 50.
    list_idinteger
    Return only numbers in this monitoring list. Leave empty for all lists. Example: 12.
    statusstring
    Return only numbers with this status. Leave empty for all numbers. Example: flagged.one of pendingcleanflaggedunknown
  • callerapi_did_schedule_getGet the DID monitoring check schedule and its estimated monthly credit cost.Read-only

    Get Check Schedule

    Get the DID monitoring check schedule and its estimated monthly credit cost. Returns enabled, mode, interval_minutes or times, weekdays, the daily window and timezone, and a one-month credit estimate. Use this before callerapi_did_schedule_update. Returns 404 when no numbers were submitted yet. Does not use credits.

    Inputs

    list_idinteger
    Monitoring list whose schedule to read. Leave empty for the default list. Example: 12.
  • callerapi_did_webhook_getGet the DID monitoring webhook URL and its delivery state.Read-only

    Get DID Webhook

    Get the DID monitoring webhook URL and its delivery state. Returns url, active and, when CallerAPI turned the webhook off, a note with the reason. The signing secret is not returned. Use this to check webhook health. Use callerapi_did_webhook_save to set the URL.

    Inputs

    This tool takes no inputs.

  • callerapi_phone_lookupLook up a phone number's spam score, reputation and owner information, with an optional live HLR carrier check.Read-only

    Look Up Phone Spam Score

    Look up a phone number's spam score, reputation and owner information, with an optional live HLR carrier check. Returns data with business_info (owner name and entity type), carrier_info (carrier, line type, country) and complaints (reported spam subjects and counts), plus HLR status fields when hlr is true. Use this to screen a caller or a number before calling or texting it. Use callerapi_phone_ported_date_get or callerapi_phone_porting_history_get for porting data. Each lookup uses credits.

    Inputs

    phonestringrequired
    Phone number to look up, digits only with the country code first and no plus sign or spaces. Example: 18883578668.
    hlrboolean
    Set to true to also run a live HLR (Home Location Register) lookup that reports whether the number is active and reachable on its carrier. Example: true.
  • callerapi_phone_online_presence_getCheck which messaging and social platforms a phone number is registered on.Read-only

    Get Phone Online Presence

    Check which messaging and social platforms a phone number is registered on. Returns online_presence with one flag per platform (for example whatsapp, telegram, facebook, google, office365): 1 registered, 0 not registered, -1 unknown. Use this as a fraud signal: real, long-used numbers usually have an online footprint. Costs about EUR 0.15 per lookup.

    Inputs

    phonestringrequired
    Phone number to look up, digits only with the country code first and no plus sign or spaces. Example: 12124567890.
  • callerapi_phone_ported_date_getGet the date a phone number was last ported to another carrier.Read-only

    Get Phone Ported Date

    Get the date a phone number was last ported to another carrier. Returns ported (whether the number was ever ported), ported_date, ported_date_type and a status message. Use this for SIM-swap and account-takeover checks. Use callerapi_phone_porting_history_get for every past port. Costs about EUR 0.008 per lookup.

    Inputs

    phonestringrequired
    Phone number to look up, digits only with the country code first and no plus sign or spaces. Example: 18883578668.