Workspaces

A Workspace is the primary organizational boundary in the platform. It acts as a secure sandbox reflecting a single client, department, or folder ecosystem.

• Absolute Isolation: a workspace contains its Documents, Jobs, API keys and Credits. Cross-workspace access is impossible by design.
• API Scopes: a workspace key can never locate or influence data from another workspace.

🛠️ Workspace ManagementCopy Anchor Link

Workspaces support standard lifecycle operations. For a detailed technical reference of every field and parameter, see the Workspace reference.

Your WorkspaceCopy Anchor Link

A workspace-scoped key always acts on its own workspace, which it can read and rename at /workspace.

curl "https://api.axelered.com/v1/workspace" \
  -H "Authorization: Bearer YOUR_API_KEY"

The lifecycle operations below live under /admin and need a server-scoped key.

Create a WorkspaceCopy Anchor Link

Initializing a workspace is typically the first step in any integration.

curl -X POST "https://api.axelered.com/v1/admin/workspaces" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Core"
  }'

Read, List & UpdateCopy Anchor Link

To manage your existing environments, use the following specialized endpoints:

• List Workspaces: Retrieve all active workspaces accessible by your key.
• Read Workspace: Fetch the metadata of a specific workspace.
• Update Workspace: Change the name of a workspace.

Delete a WorkspaceCopy Anchor Link

Workspaces use soft-deletion. When deleted, they are hidden from listings, but their data is preserved and can be restored if necessary.

curl -X DELETE "https://api.axelered.com/v1/admin/workspaces/{workspace_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"