***

title: Purple Suite Setup
position: 1
excerpt: Set up the Purple Suite mock APIs used across all Quickstart Guides
deprecated: false
hidden: false
metadata:
title: Purple Suite Setup
description: >-
Create a Purple Suite instance and configure a connector for Agent Studio
Quickstart Guides
robots: index
-------------

# 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.

<Callout intent="info" title="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.
</Callout>

## 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:

| App                | Domain                       | Example Data                                 |
| :----------------- | :--------------------------- | :------------------------------------------- |
| **Purple ITSM**    | IT Service Management        | Incidents, changes, problems, SLAs           |
| **Purple HRS**     | Human Resources              | Employees, departments, PTO, reviews         |
| **Purple ATS**     | Applicant Tracking           | Requisitions, candidates, interviews, offers |
| **Purple ERP**     | Enterprise Resource Planning | Purchase orders, invoices, inventory, assets |
| **Purple CRM**     | Customer Relationship        | Accounts, contacts, opportunities, leads     |
| **Purple Planner** | Project Management           | Projects, tasks, sprints, milestones         |
| **Purple SCM**     | Supply Chain                 | Suppliers, contracts, shipments              |
| **Purple Pages**   | Workspace                    | Pages, databases, records                    |
| **Purple Grid**    | Spreadsheet Database         | Bases, tables, fields, records               |
| **Purple Collab**  | Team Messaging               | Channels, messages, users, files             |

## Create your instance

<Steps>
  <Step title="Go to the Purple Suite">
    Open [marketplace.moveworks.com/purple-suite](https://marketplace.moveworks.com/purple-suite) and click **+ New Instance**.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.

    <Callout intent="warning" title="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.
    </Callout>
  </Step>
</Steps>

## Set up a connector in Agent Studio

<Steps>
  <Step title="Navigate to Connectors">
    In **Agent Studio**, go to the **Connectors** section and click **Create**.
  </Step>

  <Step title="Configure the connector">
    Fill in the following details:

    | Attribute           | Value                                                  |
    | :------------------ | :----------------------------------------------------- |
    | **Connection Name** | `firstname_lastname_moveworks_purple`                  |
    | **Description**     | `Moveworks Purple APIs Connector`                      |
    | **Base Url**        | `https://marketplace.moveworks.com`                    |
    | **Auth Type**       | `Api Key`                                              |
    | **API Key**         | Your PAT from the previous section (starts with `ps_`) |
    | **Header**          | `Authorization`                                        |
    | **Prefix**          | `Bearer`                                               |

    Add a second header:

    | Header Name     | Value                                      |
    | :-------------- | :----------------------------------------- |
    | `X-Instance-ID` | Your Instance ID from the previous section |
  </Step>

  <Step title="Save the connector">
    Click **Save**. This connector is now available for all your Quickstart Guide plugins.
  </Step>
</Steps>

## Verify it works

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

```shell
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:

<CardGroup cols={2}>
  <Card title="Quickstart #1: Basic Task Agent" href="/agent-studio/quickstart-guide/quickstart-basic-task-agent" icon="fa-bolt">
    Start here. Build your first plugin that retrieves PTO balance data.
  </Card>

  <Card title="Quickstart #4: Structured Data Analysis" href="/agent-studio/quickstart-guide/quickstart-4-structured-data-analysis-sda" icon="fa-chart-bar">
    Build a plugin that fetches 500 CRM accounts for AI-powered analysis.
  </Card>
</CardGroup>