Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to VSCO Workspace (Tave)

Scalekit connector
Open markdown

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

Tools
165
What they doRead · write · destructive
75 · 63 · 2775 read63 write27 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 VSCO Workspace (Tave) connection

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

    Each user opens the link once and enters their VSCO Workspace (Tave) 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
  • tave_brand_getGet one brand by ID.Read-only

    Get Brand

    Get one brand by ID. Returns the brand with name, alias, emails, phones, office hours, custom domain and theme colors. Use tave_brand_get when you have the ID. Use tave_brands_list to browse brands.

    Inputs

    idstringrequired
    ULID of the brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
  • tave_brands_listList the studio's brands (the business identities used on client-facing pages and emails).Read-only

    List Brands

    List the studio's brands (the business identities used on client-facing pages and emails). Returns the page of brands with id, name, alias, contact emails, phones and theme. Use tave_brands_list to find a brand_id for tave_job_create or tave_contact_create. Use tave_brand_get for one brand by ID.

    Inputs

    external_mapping_idstring
    Only objects linked to this ID in an external system (external mapping ID, up to 64 characters). Example: crm-1234.
    include_hiddenboolean
    true to include hidden brands. Example: false.
    pageinteger
    Page of results, starting at 1. Example: 1.
    page_sizeinteger
    Results per page, from 10 to 100 (default 100). Example: 50.
    sort_bystring
    Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
  • tave_contact_getGet one address book entry by ID.Read-only

    Get Address Book Entry

    Get one address book entry by ID. Returns the contact with name, emails, phones, address, custom fields and jobs. Use tave_contact_get when you have the ID.

    Inputs

    idstringrequired
    ULID of the address book entry. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
  • tave_contacts_listList address book entries (people, companies and locations), optionally by email.Read-only

    List Address Book

    List address book entries (people, companies and locations), optionally by email. Returns the page of contacts with id, kind, name, email and phones. Use tave_contacts_list to browse or match an email. Use tave_search for free-text search.

    Inputs

    emailstring
    Email address to match; results are ranked by match. Example: jamie@example.com.
    include_hiddenboolean
    true to include hidden entries. Example: false.
    pageinteger
    Page of results, starting at 1. Example: 1.
    page_sizeinteger
    Results per page. Example: 50.
    sort_bystring
    Sort order: id, modified, created, name, kind, accountBalance, anniversary, anonymized, bestDayToCall, bestTimeToCall, cellPhone, companyName, contactPreference, creditBalance, email, fax, firstName, gender, homePhone, jobTitle, lastName, maidenName, previousClient, privacyOptIn, requireStrictPrivacy, salutation, schoolGradYear, schoolName, sport, teamName, teamPosition or workPhone, optionally followed by asc or desc (default id). Example: name asc.one of idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desckindkind asckind descaccountBalanceaccountBalance ascaccountBalance descanniversaryanniversary ascanniversary descanonymizedanonymized ascanonymized descbestDayToCallbestDayToCall ascbestDayToCall descbestTimeToCallbestTimeToCall ascbestTimeToCall desccellPhonecellPhone asccellPhone desccompanyNamecompanyName asccompanyName desccontactPreferencecontactPreference asccontactPreference desccreditBalancecreditBalance asccreditBalance descemailemail ascemail descfaxfax ascfax descfirstNamefirstName ascfirstName descgendergender ascgender deschomePhonehomePhone aschomePhone descjobTitlejobTitle ascjobTitle desclastNamelastName asclastName descmaidenNamemaidenName ascmaidenName descpreviousClientpreviousClient ascpreviousClient descprivacyOptInprivacyOptIn ascprivacyOptIn descrequireStrictPrivacyrequireStrictPrivacy ascrequireStrictPrivacy descsalutationsalutation ascsalutation descschoolGradYearschoolGradYear ascschoolGradYear descschoolNameschoolName ascschoolName descsportsport ascsport descteamNameteamName ascteamName descteamPositionteamPosition ascteamPosition descworkPhoneworkPhone ascworkPhone desc
  • tave_contract_getGet one contract by ID.Read-only

    Get Contract

    Get one contract by ID. Returns the contract with status, signatures and clientUrl. Use tave_contract_get to check whether a contract was signed.

    Inputs

    idstringrequired
    ULID of the contract. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
  • tave_custom_field_getGet one custom field definition by ID.Read-only

    Get Custom Field

    Get one custom field definition by ID. Returns the field with name, kind, canApplyTo, clientAccess, clientLabel, choices and token. Use tave_custom_field_get when you have the ID. Use tave_custom_fields_list to browse fields.

    Inputs

    idstringrequired
    ULID of the custom field. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
  • tave_custom_fields_listList the studio's custom fields for jobs and contacts, optionally by record type or kind.Read-only

    List Custom Fields

    List the studio's custom fields for jobs and contacts, optionally by record type or kind. Returns custom fields with id, name, kind, canApplyTo, clientAccess, choices and token. Use tave_custom_fields_list to find which custom fields exist. Use tave_custom_field_get for one field by ID.

    Inputs

    can_apply_tostring
    Only custom fields that apply to this record type: contact or job. Example: job.one of contactjob
    kindarray
    Only custom fields of these kinds: textfield, textbox, number, money, checkbox, date, decimal, dropdown, time. Example: ["dropdown", "date"].
    sort_bystring
    Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
  • tave_discount_getGet one discount by ID.Read-only

    Get Discount

    Get one discount by ID. Returns the discount with name, typeId, kind, price, description, sku and rebate flag. Use tave_discount_get when you have the ID. Use tave_discounts_list to browse discounts.

    Inputs

    idstringrequired
    ULID of the discount. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.