Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Docmosis

Scalekit connector
Open markdown

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

Tools
15
What they doRead · write · destructive
11 · 2 · 211 read2 write2 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 Docmosis connection

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

    Each user opens the link once and enters their Docmosis 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
  • docmosis_environment_readyCheck whether your Docmosis environment is active and within quota, ready to render.Read-only

    Check Environment Ready

    Check whether your Docmosis environment is active and within quota, ready to render. Returns 200 when ready and an error status otherwise. Use this before rendering in automated flows. Use docmosis_environment_summary for plan and quota details.

    Inputs

    This tool takes no inputs.

  • docmosis_environment_summaryGet details of your Docmosis environment.Read-only

    Get Environment Summary

    Get details of your Docmosis environment. Returns the plan, status, page quota and usage so far this period. Use this to check remaining quota.

    Inputs

    This tool takes no inputs.

  • docmosis_images_listList the stock images uploaded to your environment for use in templates.Read-only

    List Images

    List the stock images uploaded to your environment for use in templates. Returns each image's name, folder and size. Use this to find an image name.

    Inputs

    folderstring
    Folder path to start from. Omit to list all images. Example: logos.
    include_sub_foldersstring
    y (default) to include images in sub-folders. Example: y.one of yn
  • docmosis_pingCheck that Docmosis Cloud is online in your region.Read-only

    Ping Docmosis

    Check that Docmosis Cloud is online in your region. Returns a short status text. Use docmosis_environment_ready to check your own environment and quota.

    Inputs

    This tool takes no inputs.

  • docmosis_render_queue_getGet the current state of your environment's render queue.Read-only

    Get Render Queue

    Get the current state of your environment's render queue. Returns queue length and processing details. Use this to diagnose slow renders.

    Inputs

    This tool takes no inputs.

  • docmosis_render_tags_getGet monthly page and document counts for renders recorded with tags.Read-only

    Get Render Tag Statistics

    Get monthly page and document counts for renders recorded with tags. Returns counts per tag per month. Use this for usage reporting by customer or document type.

    Inputs

    tagsstringrequired
    Tag, or semicolon-separated tags, to report on. Example: invoices;customer-acme.
    monthstring
    Month to report on, 1 to 12. Defaults to the current month. Example: 1.
    n_monthsstring
    Number of months to report, ending at year and month. Defaults to 1. Example: 3.
    pad_blanksstring
    y to include zero values where there is no data. Example: y.one of yn
    yearstring
    Year to report on. Defaults to the current year. Example: 2026.
  • docmosis_template_batch_upload_status_getGet the status of a batch template upload job started in the Cloud Console or API.Read-only

    Get Template Batch Upload Status

    Get the status of a batch template upload job started in the Cloud Console or API. Returns jobStatus with isEnded, error counts and progress. Use this to monitor a running batch upload.

    Inputs

    user_job_idstringrequired
    Identifier of the batch upload job. Example: batch-2026-01-15.
  • docmosis_template_details_getGet the details of an uploaded template, without the file itself.Read-only

    Get Template Details

    Get the details of an uploaded template, without the file itself. Returns its name, size, description, upload time and any template errors. Use docmosis_template_structure_get for its fields and sections.

    Inputs

    template_namestringrequired
    Name of the uploaded template, including any folder path, from docmosis_templates_list. Example: samples/WelcomeTemplate.docx.