Purple Suite Setup

Set up the Purple Suite mock APIs used across all Quickstart Guides
View as Markdown

Purple Suite Setup

The Purple Suite provides mock enterprise SaaS APIs for building and testing AI agents. All Quickstart Guides in this section use Purple Suite as their backend, so you’ll need to set up an instance before starting any guide.

One-time setup

You only need to create a Purple Suite instance once. The same instance and connector can be reused across all Quickstart Guides.

What is the Purple Suite?

The Purple Suite simulates 10 enterprise systems so you can build and test plugins without needing access to real APIs:

AppDomainExample Data
Purple ITSMIT Service ManagementIncidents, changes, problems, SLAs
Purple HRSHuman ResourcesEmployees, departments, PTO, reviews
Purple ATSApplicant TrackingRequisitions, candidates, interviews, offers
Purple ERPEnterprise Resource PlanningPurchase orders, invoices, inventory, assets
Purple CRMCustomer RelationshipAccounts, contacts, opportunities, leads
Purple PlannerProject ManagementProjects, tasks, sprints, milestones
Purple SCMSupply ChainSuppliers, contracts, shipments
Purple PagesWorkspacePages, databases, records
Purple GridSpreadsheet DatabaseBases, tables, fields, records
Purple CollabTeam MessagingChannels, messages, users, files

Create your instance

1

Go to the Purple Suite

Open marketplace.moveworks.com/purple-suite and click + New Instance.

2

Name your instance

Enter a name for your instance (e.g., your name or team) and make sure Seed with sample data is checked. Click Create.

This creates your instance and populates all 10 systems with realistic mock data.

3

View your credentials

Click the three-dot menu (⋯) on your new instance card and select View credentials.

You’ll see two values:

  • Instance ID - a UUID like cfc25397-2b86-4376-8e73-09cb5021ca70
  • API Token (PAT) - starts with ps_ (e.g., ps_ICVAW647E...)

Copy both values. You’ll need them to set up your connector.

PAT Expiration

API tokens expire after 7 days. If your token expires, click the three-dot menu on your instance and select View credentials to rotate and get a new one.

Set up a connector in Agent Studio

2

Configure the connector

Fill in the following details:

AttributeValue
Connection Namefirstname_lastname_moveworks_purple
DescriptionMoveworks Purple APIs Connector
Base Urlhttps://marketplace.moveworks.com
Auth TypeApi Key
API KeyYour PAT from the previous section (starts with ps_)
HeaderAuthorization
PrefixBearer

Add a second header:

Header NameValue
X-Instance-IDYour Instance ID from the previous section
3

Save the connector

Click Save. This connector is now available for all your Quickstart Guide plugins.

Verify it works

You can test your setup by importing this API call into a new HTTP Action:

$curl -X GET "https://marketplace.moveworks.com/api/purple-suite/crm/accounts?limit=5" \
> -H "Authorization: Bearer YOUR_PAT" \
> -H "X-Instance-ID: YOUR_INSTANCE_ID"

If everything is set up correctly, you should see a JSON response with account data.

Next steps

You’re all set. Pick a Quickstart Guide to get started: