Workspaces

In Veyak, Workspaces provide the top-level boundary for isolating your work. Every collection, folder, request, environment, and history record belongs to a specific workspace.

Why Use Workspaces?

  • Context Separation — Keep personal projects, client APIs, work repositories, and open source explorations cleanly separated.
  • Independent Environments — Variables like BASE_URL or API_KEY defined in one workspace never collide with another.
  • Isolated Request History — Review and replay past requests strictly relevant to the active project context.
  • Fast Switching — Jump between entirely different API suites with a single click from the header dropdown.

Workspace Hierarchy

Application
└── Workspace ("E-Commerce Platform")
    ├── Environments
    │   ├── Development (BASE_URL: http://localhost:8080)
    │   └── Production  (BASE_URL: https://api.shop.com)
    ├── Collections
    │   ├── "Auth Service" (REST)
    │   ├── "Payment Service" (gRPC)
    │   └── "Live Order Tracking" (WebSocket)
    └── Request History

Managing Workspaces

The workspace selector is located at the top of the left sidebar.

Switching Workspaces

  1. Click the current workspace name in the selector dropdown.
  2. Select any workspace from the list.
  3. Veyak instantly switches the active collection trees, environment selectors, and recent history.

Creating a New Workspace

  1. Click the workspace selector dropdown.
  2. Click Create New Workspace at the bottom of the list.
  3. Type a descriptive name (e.g., Fintech API, Internal Microservices).
  4. Click the checkmark button or press Enter.

Renaming a Workspace

  1. Open the workspace dropdown.
  2. Hover over the workspace name and click the Pencil (Edit) icon.
  3. Type the new name and press Enter or click the checkmark.

Deleting a Workspace

  1. Open the workspace dropdown.
  2. Hover over the workspace you wish to delete and click the Trash icon.
  3. The workspace along with its collections and history will be removed.

Caution: Deleting a workspace removes all its nested collections, requests, and environment variables permanently.

State Persistence

When you close Veyak or switch between workspaces, your active state is saved to your local user data directory:

  • Currently active workspace.
  • Currently selected collection and active request tabs.
  • Active environment selection.

When you launch Veyak, you resume exactly where you left off.

Cloud Sync & User Accounts

If you use Veyak across multiple devices, you can authenticate using your user account via the User Profile menu in the title bar (powered by Auth0 PKCE).

  • Sign in to link your local workspace to your account.
  • Keep your collection definitions organized and backed up.
  • Easily transition between macOS, Linux, and Windows machines.