Docs API Client Nexuses & Workspaces

Nexuses & Workspaces

Organize clusters into nexuses (workspaces). Create local or cloud nexuses, manage members and roles, publish or import.

What Is a Nexus?

A Nexus is a workspace that holds one or more clusters. Think of it as a project-level container. Every request belongs to a cluster, and every cluster belongs to a nexus.

By default, VortexHQ starts with a Local nexus — your clusters are stored on disk and never leave your machine unless you explicitly sync.

Workspace Selector

The workspace selector sits at the top of the API sidebar. It shows the active nexus name and avatar. Click it to open the workspace dropdown which displays:

  • Pending invites — Accept or decline invitations to other users' cloud nexuses
  • Your nexuses — All local and cloud nexuses with their avatars
  • Create Nexus button — Start a new workspace

Creating a Nexus

Click Create Nexus and choose the type:

TypeDescription
LocalStored locally on your machine. No cloud sync. Unlimited.
CloudSynced to VortexHQ cloud. Supports real-time collaboration, members, and sharing. Subject to plan limits.

Nexus Context Menu

Right-click a nexus in the sidebar for these actions:

  • New Cluster — Create an empty cluster in this nexus
  • AI Generate Cluster — Generate a full cluster from a text description
  • Import from Project — Scan a local project's route files and generate a cluster
  • Members — Manage nexus members (cloud only)
  • Sync All — Pull latest changes for all clusters in this nexus
  • Publish to Cloud — Convert a local nexus to a cloud nexus (one-way migration)
  • Refresh — Re-fetch nexus data from cloud
  • Rename / Delete

Members & Invitations

Cloud nexuses support team collaboration. Open the Members panel to:

  • Invite by email — Type an email address and send an invitation
  • Search users — Find registered VortexHQ users
  • Manage roles — Assign Owner, Editor, or Viewer roles
  • View pending invites — See who has been invited but hasn't accepted yet
  • Remove members — Revoke access
RolePermissions
OwnerFull access — create, edit, delete clusters, manage members, change settings
EditorCreate and edit clusters and requests, cannot manage members or delete the nexus
ViewerRead-only access — can view clusters but cannot edit anything

Publishing a Local Nexus

If you started with a local nexus and want to collaborate, right-click it and choose Publish to Cloud. This migrates the nexus and all its clusters to VortexHQ cloud. The operation is one-way — you cannot unpublish back to local.

Importing a Cloud Nexus

When you accept an invitation, the cloud nexus appears in your workspace selector. You can also import a full nexus (with all its clusters) from the cloud via the Import Nexus option.

Last updated 4 hours ago