Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Documenso

Scalekit connector
Open markdown

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

Tools
29
What they doRead · write · destructive
8 · 13 · 88 read13 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 Documenso connection

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

    Each user opens the link once and enters their Documenso 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
  • documenso_attachments_listList the link attachments of an envelope (supporting documents shown to recipients).Read-only

    List Envelope Attachments

    List the link attachments of an envelope (supporting documents shown to recipients). Returns each attachment's ID, label and URL.

    Inputs

    envelope_idstringrequired
    ID of the envelope (document or template). Get it from documenso_envelopes_list. Example: envelope_7f3c1a2b9d4e5f60718293a4.
  • documenso_envelope_audit_log_listList the audit log of an envelope: views, signatures, emails and changes.Read-only

    List Envelope Audit Log

    List the audit log of an envelope: views, signatures, emails and changes. Returns each event's type, actor, time and data, with paging.

    Inputs

    envelope_idstringrequired
    ID of the envelope (document or template). Get it from documenso_envelopes_list. Example: envelope_7f3c1a2b9d4e5f60718293a4.
    order_by_columnstring
    Column to sort by. Example: createdAt.one of createdAt
    order_by_directionstring
    Sort direction. Example: desc.one of ascdesc
    pagenumber
    Page number, starting at 1. Example: 1.
    per_pagenumber
    Results per page, up to 100. Example: 20.
  • documenso_envelope_getGet one envelope with its items (PDFs), recipients, fields and settings.Read-only

    Get Envelope

    Get one envelope with its items (PDFs), recipients, fields and settings. Returns the envelope's title, type, status, items, recipients with signing status, fields and meta. Use documenso_envelopes_list to find the ID.

    Inputs

    envelope_idstringrequired
    ID of the envelope (document or template). Get it from documenso_envelopes_list. Example: envelope_7f3c1a2b9d4e5f60718293a4.
  • documenso_envelopes_get_manyGet up to 20 envelopes at once by their numeric document or template IDs.Read-only

    Get Multiple Envelopes

    Get up to 20 envelopes at once by their numeric document or template IDs. Returns the matching envelopes. Use documenso_envelope_get for a single envelope ID.

    Inputs

    idsobjectrequired
    Which IDs to look up: an object with type (documentId or templateId) and ids, a list of up to 20 numbers. Example: {"type": "documentId", "ids": [101, 102]}.
  • documenso_envelopes_listList envelopes (documents and templates), with a text search, type, status, folder and template filters, and paging.Read-only

    List Envelopes

    List envelopes (documents and templates), with a text search, type, status, folder and template filters, and paging. Returns each envelope's ID, title, type, status, recipients and dates, plus paging totals. Use documenso_envelope_get for one envelope's items, recipients and fields.

    Inputs

    folder_idstring
    Only envelopes in this folder. Get it from documenso_folders_list. Example: folder_abc123.
    has_expired_recipientsstring
    true for envelopes with expired recipients. Example: false.one of truefalse
    order_by_columnstring
    Column to sort by. Example: createdAt.one of createdAt
    order_by_directionstring
    Sort direction. Example: desc.one of ascdesc
    pagenumber
    Page number, starting at 1. Example: 1.
    per_pagenumber
    Results per page, up to 100. Example: 20.
    querystring
    Text to search in titles and recipient emails. Example: NDA.
    sourcestring
    How the document was created. Example: DOCUMENT.one of DOCUMENTTEMPLATETEMPLATE_DIRECT_LINK
    statusstring
    Only envelopes with this status. Example: PENDING.one of DRAFTPENDINGCOMPLETEDREJECTEDCANCELLED
    template_idnumber
    Only documents created from this template ID. Example: 42.
    typestring
    DOCUMENT or TEMPLATE. Example: DOCUMENT.one of DOCUMENTTEMPLATE
  • documenso_field_getGet one field (signature, text, date and so on) of an envelope.Read-only

    Get Field

    Get one field (signature, text, date and so on) of an envelope. Returns the field's type, recipient, page, position, size and settings.

    Inputs

    field_idnumberrequired
    Numeric ID of the field. Get it from documenso_envelope_get. Example: 501.
  • documenso_folders_listList document or template folders, with a search, parent filter and paging.Read-only

    List Folders

    List document or template folders, with a search, parent filter and paging. Returns each folder's ID, name, type and parent.

    Inputs

    pagenumber
    Page number, starting at 1. Example: 1.
    parent_idstring
    Only folders inside this folder. Example: folder_root123.
    per_pagenumber
    Results per page, up to 100. Example: 20.
    querystring
    Text to search folder names. Example: Contracts.
    typestring
    DOCUMENT or TEMPLATE. Example: DOCUMENT.one of DOCUMENTTEMPLATE
  • documenso_recipient_getGet one recipient of an envelope.Read-only

    Get Recipient

    Get one recipient of an envelope. Returns the recipient's email, name, role, signing order, status and fields.

    Inputs

    recipient_idnumberrequired
    Numeric ID of the recipient. Get it from documenso_envelope_get. Example: 301.