Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Vibe

Scalekit connector
Open markdown

The Vibe connector lets your AI agent act in each user's Vibe account. Each user signs in to Vibe once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 34 tools.

Tools
34
What they doRead · write · destructive
21 · 9 · 421 read9 write4 destructive
Users sign in with
OAuth app
Your own Vibe app

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 Vibe connection

    In AgentKit > Connections, create a Vibe connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Vibe connections use your own OAuth app. Register one with Vibe and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Vibe connection.

  5. 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 = 'vibe'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Vibe:', 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: 'vibe_get_account_balance',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • vibe_get_account_balanceGet the current billing balance of the authenticated Vibe account.Read-only

    Get Account Balance

    Get the current billing balance of the authenticated Vibe account. Returns the account id, currency, balance in cents (balance_cents) and when it was last updated. The balance is Vibe's authoritative running total of what is owed, so it is not expected to match a sum of individual billing operations exactly. Use this for the amount owed right now; to browse individual invoices, use vibe_list_invoices. Requires the billing:read OAuth scope.

    Inputs

    This tool takes no inputs.

  • vibe_get_advertiserGet one Vibe advertiser by its ID.Read-only

    Get Advertiser

    Get one Vibe advertiser by its ID. Returns the advertiser's id, name, url, industry, apps (app_id and os), and created/updated timestamps. Use this when you already have the advertiser ID; to search or browse advertisers, use vibe_list_advertisers. Requires the advertisers:read scope.

    Inputs

    advertiser_idstringrequired
    UUID of the advertiser to retrieve. Get it from vibe_list_advertisers. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b.
  • vibe_get_audienceGet a single persistent Vibe audience by its ID.Read-only

    Get Audience

    Get a single persistent Vibe audience by its ID. Returns the audience's id, advertiser id, name, display name, description, external audience key, status (ACTIVE or INACTIVE), and created and updated timestamps. Use this when you already have an audience_id; to find the audiences of an advertiser, use vibe_list_audiences. Requires the audiences:read OAuth scope.

    Inputs

    audience_idstringrequired
    Stable identifier of the audience to retrieve. Required. Take it from the id field returned by vibe_list_audiences. Example: 3f2a9b64-8d1e-4c07-b5a3-6e7d0c1f2a98.
  • vibe_get_campaignGet one Vibe campaign by its ID.Read-only

    Get Campaign

    Get one Vibe campaign by its ID. Returns the campaign's id, advertiser_id, name, goal, status, state, active, attribution_window_in_hours, optimization_goal, start/end dates and budget (derived from its strategies), publication_date, and created/updated timestamps. Use this when you already have the campaign ID; to search or browse campaigns, use vibe_list_campaigns. Requires the campaigns:read scope.

    Inputs

    campaign_idstringrequired
    UUID of the campaign to retrieve. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
  • vibe_get_strategyGet one Vibe strategy by its id.Read-only

    Get Strategy

    Get one Vibe strategy by its id. Returns the strategy's campaign_id, name, budget, budget_type, starts_at, ends_at, active flag, review state (AUTHORIZED, BLOCKED or PENDING_REVIEW), targeting object, creative_ids and timestamps. Use this when you already have a strategy id; use vibe_list_strategies to find strategies and vibe_list_strategy_creatives for full creative records (a strategy only carries creative ids). Requires the campaigns:read OAuth scope.

    Inputs

    strategy_idstringrequired
    UUID of the Vibe strategy to retrieve. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
  • vibe_list_accountsList the Vibe accounts the connected app can access.Read-only

    List Accounts

    List the Vibe accounts the connected app can access. Returns a plain array (no pagination) with each account's id, name, currency, timezone, status (ACTIVE, BLOCKED, or ONBOARDING), and created/updated timestamps. Use this to see which accounts the app can act on; to browse the advertisers inside the account, use vibe_list_advertisers. Requires the account:read scope.

    Inputs

    This tool takes no inputs.

  • vibe_list_advertisersList the advertisers in the Vibe account, optionally filtered by ID, name, or URL.Read-only

    List Advertisers

    List the advertisers in the Vibe account, optionally filtered by ID, name, or URL. Returns a page with data, total, limit, and offset; each advertiser has id, name, url, industry, apps (app_id and os), and created/updated timestamps. Use this to browse or find an advertiser ID; to fetch one advertiser by ID, use vibe_get_advertiser, and to see its campaigns, use vibe_list_campaigns. Requires the advertisers:read scope.

    Inputs

    idstring
    Return only the advertiser with this UUID. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b. To fetch a single advertiser by ID, vibe_get_advertiser is more direct.
    limitinteger
    Maximum number of advertisers to return in one page. Defaults to 20; Vibe's pagination guide sets a maximum of 5000. Combine with offset to page through results.default 20
    namestring
    Case-insensitive 'contains' filter on the advertiser name. Example: acme.
    offsetinteger
    Number of advertisers to skip before returning results, for paging. Defaults to 0. For the next page, add the previous limit to the previous offset; stop when offset reaches the total in the response.default 0
    urlstring
    Case-insensitive 'contains' filter on the advertiser URL. Example: acme.com.
  • vibe_list_age_rangesList the age ranges that can be targeted in a Vibe strategy.Read-only

    List Age Ranges

    List the age ranges that can be targeted in a Vibe strategy. Returns the complete list with no pagination, each with an id (RANGE_18_20, RANGE_21_24, RANGE_25_34, RANGE_35_44, RANGE_45_54, RANGE_55_64 or RANGE_65_MORE) and a display name. Use this to look up age-range IDs for strategy targeting; for gender use vibe_list_genders, and for other demographic segments use vibe_list_demographics. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.

    Inputs

    This tool takes no inputs.