Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Paradym

Scalekit connector
Open markdown

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

Tools
60
What they doRead · write · destructive
29 · 23 · 829 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 Paradym connection

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

    Each user opens the link once and enters their Paradym 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
  • paradym_anoncreds_template_getGet one AnonCreds credential template by ID.Read-only

    Get AnonCreds Template

    Get one AnonCreds credential template by ID. Returns archivedAt, updatedAt, createdAt, attributes, definition, schema, name, issuer, description, revocable. Use paradym_anoncreds_templates_list to find the ID.

    Inputs

    credential_template_idstringrequired
    The id of the credential template. Example: clu921ps300047eghxvhz33m5
    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
  • paradym_anoncreds_templates_listList the AnonCreds credential templates in a wallet (used with DIDComm).Read-only

    List AnonCreds Templates

    List the AnonCreds credential templates in a wallet (used with DIDComm). Returns data (a list of records with archivedAt, updatedAt, createdAt, attributes, definition, schema, name, issuer, description, revocable). Use this to find a template ID for DIDComm issuance.

    Inputs

    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
    filter_archivedboolean
    true returns only archived templates. Without it, archived templates are left out. Example: true
    filter_idstring
    Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
    filter_revocableboolean
    Only return results whose revocable is this value. Example: true
    page_afterstring
    Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
    page_beforestring
    Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
    page_sizenumber
    Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
    search_namestring
    Only return results whose name contains this value, ignoring case. Example: Employee
    sortstring
    Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of id-idcreatedAt-createdAtupdatedAt-updatedAt
  • paradym_common_trusted_entities_listList the common trusted entities Paradym provides to every wallet.Read-only

    List Common Trusted Entities

    List the common trusted entities Paradym provides to every wallet. Returns data (a list of records with etsiLotes, certificates, dids, description, name, updatedAt, createdAt, id). Use paradym_trusted_entities_list for the wallet's own entries.

    Inputs

    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
    filter_idstring
    Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
    page_afterstring
    Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
    page_beforestring
    Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
    page_sizenumber
    Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
    search_namestring
    Only return results whose name contains this value, ignoring case. Example: Employee
    sortstring
    Sort property; prefix with - for descending, e.g. -createdAt. One of: createdAt, -createdAt, updatedAt, -updatedAt, id, -id. Example: createdAtone of createdAt-createdAtupdatedAt-updatedAtid-id
  • paradym_didcomm_connection_getGet one DIDComm connection by ID.Read-only

    Get DIDComm Connection

    Get one DIDComm connection by ID. Returns id, displayName, logoUrl, ourDid, theirDid, createdAt, updatedAt. Use paradym_didcomm_connections_list to find the ID.

    Inputs

    didcomm_connection_idstringrequired
    The id of the DIDComm connection. Example: clu921ps300047eghxvhz33mb
    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
  • paradym_didcomm_connections_listList DIDComm connections of a wallet.Read-only

    List DIDComm Connections

    List DIDComm connections of a wallet. Returns data (a list of records with id, displayName, logoUrl, ourDid, theirDid, createdAt, updatedAt). Use this to find a connection ID for messaging, issuance or verification.

    Inputs

    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
    filter_didcomm_invitation_idstring
    Only return results whose didcommInvitationId is this value. Example: example
    filter_display_namestring
    Only return results whose displayName is this value. Example: Example name
    filter_idstring
    Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
    page_afterstring
    Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
    page_beforestring
    Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
    page_sizenumber
    Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
    search_display_namestring
    Only return results whose displayName contains this value, ignoring case. Example: Example name
    sortstring
    Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of id-idcreatedAt-createdAtupdatedAt-updatedAt
  • paradym_didcomm_invitation_getGet one DIDComm invitation, including its invitation URL.Read-only

    Get DIDComm Invitation

    Get one DIDComm invitation, including its invitation URL. Returns id, status, reusable, createdAt, updatedAt, expiresAt, did, invitationUri, invitationQrUri, invitationDeeplinkUri. Use paradym_didcomm_invitations_list to find the ID.

    Inputs

    didcomm_invitation_idstringrequired
    The id of the DIDComm invitation. Example: clu921ps300047eghxvhz33mc
    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
  • paradym_didcomm_invitations_listList DIDComm out-of-band invitations created by a wallet.Read-only

    List DIDComm Invitations

    List DIDComm out-of-band invitations created by a wallet. Returns data (a list of records with id, status, reusable, createdAt, updatedAt, expiresAt, did, invitationUri, invitationQrUri, invitationDeeplinkUri). Use paradym_didcomm_invitation_create to make a new one.

    Inputs

    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
    filter_idstring
    Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
    filter_reusableboolean
    Only return results whose reusable is this value. Example: true
    page_afterstring
    Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
    page_beforestring
    Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
    page_sizenumber
    Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
    sortstring
    Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of id-idcreatedAt-createdAtupdatedAt-updatedAt
  • paradym_didcomm_issuance_getGet one DIDComm issuance session and its status.Read-only

    Get DIDComm Issuance

    Get one DIDComm issuance session and its status. Returns id, status, credential, error, didcommInvitationId, didcommConnectionId, createdAt, updatedAt, expiresAt. Poll this after creating an offer.

    Inputs

    didcomm_issuance_idstringrequired
    The id of the DIDComm issuance session. Example: clu921ps300047eghxvhz33me
    wallet_idstringrequired
    ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4