Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Coassemble

Scalekit connector
Open markdown

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

Tools
56
What they doRead · write · destructive
24 · 23 · 924 read23 write9 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 Coassemble connection

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

    Each user opens the link once and enters their Coassemble 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
  • coassemble_allowances_getGet the workspace's AI allowances and usage, such as narration characters and image generations.Read-only

    Get Workspace Allowances

    Get the workspace's AI allowances and usage, such as narration characters and image generations. Returns each allowance's limit and use. Use coassemble_client_usage_list for per-client usage.

    Inputs

    This tool takes no inputs.

  • coassemble_client_allowances_getGet one client's AI caps and usage.Read-only

    Get Client AI Allowances

    Get one client's AI caps and usage. Returns narration and image caps and usage. Use coassemble_client_caps_update to change caps.

    Inputs

    identifierstringrequired
    Your identifier for the client. Example: user_123.
  • coassemble_client_default_caps_getGet the default AI caps applied to new clients.Read-only

    Get Default Client AI Caps

    Get the default AI caps applied to new clients. Returns clientCapsEnabled and the default narration and image caps. Use coassemble_client_default_caps_update to change them.

    Inputs

    This tool takes no inputs.

  • coassemble_client_getGet one client by its identifier.Read-only

    Get Client

    Get one client by its identifier. Returns the client's identifier and metadata. Use coassemble_client_update to change metadata.

    Inputs

    identifierstringrequired
    Your identifier for the client. Example: user_123.
  • coassemble_client_usage_listList AI usage per client over a date range (up to 366 days).Read-only

    List Client Usage

    List AI usage per client over a date range (up to 366 days). Returns per-client metric usage, paged. Use coassemble_client_allowances_get for one client's caps.

    Inputs

    endstring
    End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
    lengthinteger
    Items per page. Defaults to 100. Example: 50.
    pageinteger
    Page number, starting at 0. Defaults to 0. Example: 0.
    startstring
    Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
  • coassemble_clients_listList the clients (tenants) in the workspace.Read-only

    List Clients

    List the clients (tenants) in the workspace. Returns each client's identifier, metadata and created date. Use a client identifier to scope other tools.

    Inputs

    lengthinteger
    Items per page. Defaults to 100. Example: 50.
    pageinteger
    Page number, starting at 0. Defaults to 0. Example: 0.
  • coassemble_collection_getGet one collection with its courses.Read-only

    Get Collection

    Get one collection with its courses. Returns the collection's title, description, courses and share settings. Use coassemble_collection_update to change it.

    Inputs

    idstringrequired
    Collection ID, from coassemble_collections_list. Example: 1234.
  • coassemble_collection_tracking_getGet one collection tracking record.Read-only

    Get Collection Tracking

    Get one collection tracking record. Returns the learner, collection, progress and timestamps. Use an id from coassemble_collection_trackings_list.

    Inputs

    idstringrequired
    Collection tracking ID. Example: 1234.