Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Bird

Scalekit connector
Open markdown

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

Tools
457
What they doRead · write · destructive
252 · 155 · 50252 read155 write50 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 Bird connection

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

    Each user opens the link once and enters their Bird 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
  • bird_amb_attachment_getReturn the metadata of an attachment by its `aat_` ID.Read-only

    Get Apple Messages Attachment

    Return the metadata of an attachment by its `aat_` ID. Returns an object with id, business_account_id, origin, message_id, name, mime_type, size, expires_at, created_at.

    Inputs

    attachment_idstringrequired
    Attachment identifier. Starts with `aat_`. Example: aat_01krdgeqcxet5s7t44vh8rt9mg
  • bird_amb_business_account_events_listReturn account activity with event time, summary and source metadata, newest first by default.Read-only

    List Apple Business Account Events

    Return account activity with event time, summary and source metadata, newest first by default. Returns data, an array of items with id, type, summary, metadata, created_at, plus next_cursor (pass it as starting_after for the next page; null on the last page). Needs business_account_id from bird_amb_business_accounts_list.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list. Example: abz_01krdgeqcxet5s7t44vh8rt9mg
    ending_beforestring
    Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
    include_totalboolean
    When true, the response includes a `total` field with the total number of items matching the request's filters across all pages. Example: false
    limitinteger
    Maximum number of items to return per page. Example: 25
    orderstring
    Sort direction. Defaults to `desc`, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Example: descone of ascdesc
    sortstring
    Field to sort by. Possible values: `created_at`. Defaults to `created_at`. Example: created_atone of created_at
    starting_afterstring
    Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
  • bird_amb_business_account_getReturn your workspace's Apple Messages for Business record, including its current status with Apple.Read-only

    Get Apple Messages for Business Record

    Return your workspace's Apple Messages for Business record, including its current status with Apple. Returns an object with id, apple_business_id, name, status, status_reason, invitations_enabled, created_at, updated_at, next, account_review_status, finish_setup_url. Use this when you have the ID. Use bird_amb_business_accounts_list to find one. Needs business_account_id from bird_amb_business_accounts_list.

    Inputs

    business_account_idstringrequired
    Bird business account ID (abz_) or Apple business UUID. Both resolve within the current workspace. Example: abz_01jbx7k3m9p2q5r8s4t6v0w1yz
  • bird_amb_business_account_submissions_listReturn review attempts with frozen evidence for this business, newest first, with fresh private evidence URLs.Read-only

    List Apple Messages for Business Submissions

    Return review attempts with frozen evidence for this business, newest first, with fresh private evidence URLs. Returns data, an array of items with id, business_account_id, apple_business_id, name, readiness_attachment, use_cases_attachment, video_attachment, status, status_reason, decided_by, plus next_cursor (pass it as starting_after for the next page; null on the last page). Needs business_account_id from bird_amb_business_accounts_list.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list. Example: abz_01krdgeqcxet5s7t44vh8rt9mg
    ending_beforestring
    Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
    include_totalboolean
    When true, the response includes a `total` field with the total number of items matching the request's filters across all pages. Example: false
    limitinteger
    Maximum number of items to return per page. Example: 25
    orderstring
    Sort direction. Defaults to `desc`, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Example: descone of ascdesc
    sortstring
    Field to sort by. Possible values: `created_at`. Defaults to `created_at`. Example: created_atone of created_at
    starting_afterstring
    Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
  • bird_amb_business_accounts_listReturn a paginated list of your workspace's Apple Messages for Business records.Read-only

    List Apple Messages for Business Records

    Return a paginated list of your workspace's Apple Messages for Business records. Returns data, an array of items with id, apple_business_id, name, status, status_reason, invitations_enabled, created_at, updated_at, next, account_review_status, plus next_cursor (pass it as starting_after for the next page; null on the last page). Use this to browse or filter. Use bird_amb_business_account_get when you already have the ID.

    Inputs

    ending_beforestring
    Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
    include_totalboolean
    When true, the response includes a `total` field with the total number of items matching the request's filters across all pages. Example: false
    limitinteger
    Maximum number of items to return per page. Example: 25
    orderstring
    Sort direction. Defaults to `desc`, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Example: descone of ascdesc
    sortstring
    Field to sort by. Possible values: `created_at`. Defaults to `created_at`. Example: created_atone of created_at
    starting_afterstring
    Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
  • bird_amb_channel_settings_getReturn the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it.Read-only

    Get Apple Messages for Business Channel Settings

    Return the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it. Returns an object with entry_points, default_locale, brand_name, logo_asset_id. Needs business_account_id from bird_amb_business_accounts_list.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list. Example: abz_01krdgeqcxet5s7t44vh8rt9mg
  • bird_amb_conversation_getReturn one conversation, including closed conversations.Read-only

    Get Apple Messages Conversation

    Return one conversation, including closed conversations. Returns an object with inbox_status, recipient, routing, routing_change, last_message, id, business_account_id, status, origin, device_capabilities, supported_content_kinds, locale and more. Use this when you have the ID. Use bird_amb_conversations_list to find one. Needs conversation_id from bird_amb_conversations_list.

    Inputs

    conversation_idstringrequired
    Conversation identifier. Starts with `acv_`. Example: acv_01krdgeqcxet5s7t44vh8rt9mg
  • bird_amb_conversation_messages_listReturn the messages in a conversation, newest first, both received and sent.Read-only

    List Apple Messages Messages in a Conversation

    Return the messages in a conversation, newest first, both received and sent. Returns data, an array of items with id, conversation_id, business_account_id, from, to, direction, status, kind, source, text, plus next_cursor (pass it as starting_after for the next page; null on the last page). Needs conversation_id from bird_amb_conversations_list.

    Inputs

    conversation_idstringrequired
    Conversation identifier. Starts with `acv_`. Example: acv_01krdgeqcxet5s7t44vh8rt9mg
    directionstring
    Filter to received (`inbound`) or sent (`outbound`) messages. Example: outboundone of outboundinbound
    ending_beforestring
    Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd
    limitinteger
    Maximum number of items to return per page. Example: 25
    starting_afterstring
    Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order. Example: WyIyMDI2LTAxLTE1VDA5OjMwOjAwWiJd