Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Brilliant Directories

Scalekit connector
Open markdown

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

Tools
48
What they doRead · write · destructive
27 · 14 · 727 read14 write7 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 Brilliant Directories connection

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

    Each user opens the link once and enters their Brilliant Directories 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
  • brilliantdirectories_album_getGet one multi-image post (album) by ID.Read-only

    Get Album

    Get one multi-image post (album) by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_albums_list.

    Inputs

    group_idstringrequired
    ID of the multi-image post (album). Example: 77.
  • brilliantdirectories_album_photo_getGet one album photo by ID.Read-only

    Get Album Photo

    Get one album photo by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_album_photos_list.

    Inputs

    photo_idstringrequired
    ID of the album photo. Example: 905.
  • brilliantdirectories_album_photos_listList album photos on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-only

    List Album Photos

    List album photos on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of album photo records with total and next_page. Use brilliantdirectories_album_photo_get for one record.

    Inputs

    limitinteger
    Records per page: 25 by default, up to 100. Example: 25.
    order_columnstring
    Column to sort by, or a comma-separated list. Example: last_name.
    order_typestring
    Sort direction: ASC (default), DESC or RAND. Example: ASC.one of ASCDESCRAND
    pagestring
    Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
    propertystring
    Field name to filter on, for example active, email or signup_date. Example: active.
    property_logicstring
    Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
    property_valuestring
    Value to compare property with (not needed for is_null / is_not_null). Example: 2.
  • brilliantdirectories_albums_listList multi-image post (album)s on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-only

    List Albums

    List multi-image post (album)s on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of multi-image post (album) records with total and next_page. Use brilliantdirectories_album_get for one record.

    Inputs

    limitinteger
    Records per page: 25 by default, up to 100. Example: 25.
    order_columnstring
    Column to sort by, or a comma-separated list. Example: last_name.
    order_typestring
    Sort direction: ASC (default), DESC or RAND. Example: ASC.one of ASCDESCRAND
    pagestring
    Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
    propertystring
    Field name to filter on, for example active, email or signup_date. Example: active.
    property_logicstring
    Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
    property_valuestring
    Value to compare property with (not needed for is_null / is_not_null). Example: 2.
  • brilliantdirectories_api_key_verifyCheck that the API key is valid.Read-only

    Verify API Key

    Check that the API key is valid. Returns the website URL and the key's name. Use it as a connection test.

    Inputs

    This tool takes no inputs.

  • brilliantdirectories_click_getGet one member link click by ID.Read-only

    Get Click

    Get one member link click by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_clicks_list.

    Inputs

    click_idstringrequired
    ID of the member link click. Example: 9001.
  • brilliantdirectories_clicks_listList member link clicks on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-only

    List Clicks

    List member link clicks on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member link click records with total and next_page. Use brilliantdirectories_click_get for one record. Clicks record visitors clicking a member's links (website, phone, social).

    Inputs

    limitinteger
    Records per page: 25 by default, up to 100. Example: 25.
    order_columnstring
    Column to sort by, or a comma-separated list. Example: last_name.
    order_typestring
    Sort direction: ASC (default), DESC or RAND. Example: ASC.one of ASCDESCRAND
    pagestring
    Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
    propertystring
    Field name to filter on, for example active, email or signup_date. Example: active.
    property_logicstring
    Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
    property_valuestring
    Value to compare property with (not needed for is_null / is_not_null). Example: 2.
  • brilliantdirectories_lead_getGet one lead by ID.Read-only

    Get Lead

    Get one lead by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_leads_list.

    Inputs

    lead_idstringrequired
    ID of the lead. Example: 201.