Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Conveyor

Scalekit connector
Open markdown

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

Tools
47
What they doRead · write · destructive
29 · 15 · 329 read15 write3 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 Conveyor connection

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

    Each user opens the link once and enters their Conveyor 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
  • conveyor_access_groups_listList the Trust Center access groups that control which documents a reviewer can see.Read-only

    List Access Groups

    List the Trust Center access groups that control which documents a reviewer can see. Returns each access group's id and name. Use these IDs when granting or updating an authorization.

    Inputs

    This tool takes no inputs.

  • conveyor_audit_events_listList audit events in your Conveyor organization, filtered by date, source, category, actor or action.Read-only

    List Audit Events

    List audit events in your Conveyor organization, filtered by date, source, category, actor or action. Returns a page of events with actor, action, subject and time. Use since for incremental polling.

    Inputs

    action_typestring
    Comma-separated action types, e.g. `user.logged_in`, `role.updated`. Example: user.logged_in.
    actor_emailstring
    Provide a comma-separated list to filter by actor emails. Example: admin@yourcompany.com.
    actor_typestring
    Filter events by actor_type. Provide a comma-separated list to filter by multiple actor_types. Example: user.one of api_keyconveyor_supportsamluser
    categorystring
    Filter events by category. Provide a comma-separated list to filter by multiple categories. Example: user.
    end_datestring
    Events on or before the end of this UTC day (YYYY-MM-DD). Omit to include everything up to now. Example: 2026-01-31.
    pageinteger
    Page number to return, starting at 1. Example: 1.
    per_pageinteger
    Number of results per page. Example: 25.
    sincestring
    Events at or after this exact moment, as an ISO 8601 timestamp, e.g. 2026-10-01T12:00:00Z. Read as UTC unless it includes an offset (encode + as %2B). Use it to poll for new events. Example: 2026-01-15T00:00:00Z.
    sort_dirstring
    Sort events in ascending or descending order. Example: desc.one of ascdesc
    sourcestring
    Filter events by source. Provide a comma-separated list to filter by multiple sources. Example: ui.one of uiapi_keyoauthscimsamladmin_consoleconsole
    start_datestring
    Events on or after the start of this UTC day (YYYY-MM-DD). Omit to start from the first event. Example: 2026-01-01.
    subject_typestring
    Filter events by subject_type. Provide a comma-separated list to filter by multiple subject_types. Example: User.
  • conveyor_authorization_request_getGet one Trust Center access request by ID.Read-only

    Get Access Request

    Get one Trust Center access request by ID. Returns the requester's email, company, status, NDA details and dates. Use List Access Requests to find the ID.

    Inputs

    authorization_request_idstringrequired
    The ID of the authorization request. Example: 3f6c2b1e-8a4d-4f2b-9c1e-5d7a8b9c0d1e.
  • conveyor_authorization_request_queue_getGet the queue of Trust Center access requests waiting for a decision.Read-only

    Get Access Request Queue

    Get the queue of Trust Center access requests waiting for a decision. Returns the pending requests with requester details. Use this to triage new requests; use List Access Requests to search all requests.

    Inputs

    This tool takes no inputs.

  • conveyor_authorization_requests_listList requests from people asking for access to the Conveyor Trust Center, optionally by status or email.Read-only

    List Access Requests

    List requests from people asking for access to the Conveyor Trust Center, optionally by status or email. Returns each request's id, requester email, company, status and dates. Use Grant Access to approve one, or Ignore Access Request to dismiss it.

    Inputs

    emailstring
    Only return requests from this requester email. Example: reviewer@customer.com.
    statusstring
    Only return requests in this status: initial, requested, authorized or ignored. Example: requested.
  • conveyor_authorizations_listList the people who have, or had, access to the Conveyor Trust Center, optionally by status or email.Read-only

    List Authorizations

    List the people who have, or had, access to the Conveyor Trust Center, optionally by status or email. Returns each authorization's id, email, status, access groups, NDA signature and expiry. Use Update Authorization to change access groups or revoke access.

    Inputs

    emailstring
    Only return the authorization for this reviewer email. Example: reviewer@customer.com.
    statusstring
    Only return authorizations in this status: gated, authorized or revoked. Example: authorized.
  • conveyor_collaboration_groups_listList the collaboration groups questionnaire questions can be assigned to.Read-only

    List Collaboration Groups

    List the collaboration groups questionnaire questions can be assigned to. Returns each group's id and name. Use these IDs in Update Questionnaire Question.

    Inputs

    This tool takes no inputs.

  • conveyor_connection_interactions_listList the Trust Center interactions of one customer company (connection).Read-only

    Get Connection Interactions

    List the Trust Center interactions of one customer company (connection). Returns a page of that company's document and Q&A interactions. Use List Connections to find the connection ID.

    Inputs

    connection_idstringrequired
    UUID for the connection. This can be found from the GET Connections endpoint. Example: 3f6c2b1e-8a4d-4f2b-9c1e-5d7a8b9c0d1e.
    created_at_endstring
    Only include items created on or before this date (YYYY-MM-DD). Example: 2026-01-31.
    created_at_startstring
    Only include items created on or after this date (YYYY-MM-DD). Example: 2026-01-01.
    pageinteger
    Page number to return, starting at 1. Example: 1.
    per_pageinteger
    Number of results per page. Example: 25.
    typestring
    Only return interactions of this type: Document (document views and downloads) or Q & A (question lookups). Example: Document.one of DocumentQ & A