Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to DocsBot AI

Scalekit connector
Open markdown

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

Tools
54
What they doRead · write · destructive
23 · 23 · 823 read23 write8 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 DocsBot AI connection

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

    Each user opens the link once and enters their DocsBot AI 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
  • docsbot_bot_getGet one DocsBot bot by ID.Read-only

    Get Bot

    Get one DocsBot bot by ID. Returns its name, description, privacy, model, embedding model, custom prompt, language, widget settings, tools, retriever tags, status and usage counts. Use List Bots to find bot IDs.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
  • docsbot_bot_reports_getGet a bot's monthly report and the list of months that have reports.Read-only

    Get Bot Reports

    Get a bot's monthly report and the list of months that have reports. Returns the available report months and the report data for the selected month. Use Get Bot Statistics for custom date ranges.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
    monthstring
    Report month as YYYY-MM. Defaults to the latest report. Example: 2026-10.
  • docsbot_bot_stats_getGet aggregated usage statistics for a bot over a number of days or a date range.Read-only

    Get Bot Statistics

    Get aggregated usage statistics for a bot over a number of days or a date range. Returns question, rating, escalation, answer-rate, sentiment and topic counts with chart labels. Use Get Bot Reports for monthly reports.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
    end_datestring
    End of the range (ISO 8601 or YYYY-MM-DD). Give with start_date. Ranges are capped at 365 days. Example: 2026-10-31.
    start_datestring
    Start of the range (ISO 8601 or YYYY-MM-DD). Give with end_date. Example: 2026-10-01.
    time_deltainteger
    Days to analyze, 0 to 365. Defaults to 30. Ignored when start_date and end_date are given. Example: 30.
  • docsbot_bots_listList the bots in a DocsBot team, with optional text search, privacy filter, sorting and paging.Read-only

    List Bots

    List the bots in a DocsBot team, with optional text search, privacy filter, sorting and paging. Returns bots with id, name, description, privacy, model, status and usage counts; any paging option returns a paginated envelope with totalCount and totalPages. Use Get Bot for one bot's full settings.

    Inputs

    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
    orderstring
    Sort direction: asc or desc. Defaults to asc for name and desc otherwise. Example: desc.one of ascdesc
    pageinteger
    Zero-based page number. Defaults to 0. Example: 1.
    page_sizeinteger
    Bots per page, 1 to 100. Defaults to 100 when paging. Example: 25.
    privacystring
    Only bots with this privacy: public or private. Example: public.one of publicprivate
    qstring
    Case-insensitive text matched against bot name and description. Example: support.
    sortstring
    Sort order field: name, newest, ai-credits or conversations. Defaults to newest. Example: conversations.one of namenewestai-creditsconversations
    viewstring
    full returns all bot settings; summary returns compact listing data. Example: summary.one of fullsummary
  • docsbot_conversation_getGet one conversation with its full message history.Read-only

    Get Conversation

    Get one conversation with its full message history. Returns the conversation fields, history messages (Human and AI, with types and question IDs) and any ticket subject and content. Use List Conversations to find conversation IDs.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    conversation_idstringrequired
    Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
  • docsbot_conversations_listList a bot's Chat Agent conversations, newest first, without message history.Read-only

    List Conversations

    List a bot's Chat Agent conversations, newest first, without message history. Returns conversations with id, title, summary, sentiment, channel, resolved and escalated status, metadata, and pagination. Use Get Conversation for the full message history.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
    pageinteger
    Zero-based page number. Defaults to 0. Example: 1.
    per_pageinteger
    Conversations per page. Defaults to 25. Example: 25.
  • docsbot_document_fetchFetch the full reconstructed text of one indexed document.Read-only

    Fetch Document

    Fetch the full reconstructed text of one indexed document. Returns the document content. Use Semantic Search first to get the file ID.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    file_idstringrequired
    File ID of the document, from a Semantic Search result. Example: doc_7f3a2b1c.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
  • docsbot_leads_exportExport a bot's leads in a date range as a CSV file.Read-only

    Export Leads

    Export a bot's leads in a date range as a CSV file. Returns a signed URL to download the CSV. Use List Leads to read leads as JSON. Needs owner, admin or editor access.

    Inputs

    bot_idstringrequired
    DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
    end_datestringrequired
    End of the created date range (ISO date-time). Example: 2026-10-31T23:59:59.999Z.
    start_datestringrequired
    Start of the created date range (ISO date-time). Example: 2026-10-01T00:00:00.000Z.
    team_idstringrequired
    DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.