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.

┌────────────────────────────────────────────────────────┐
│                   Workspace Boundary                   │
│                                                        │
│  ┌───────────────────┐         ┌────────────────────┐  │
│  │   Collection A    │         │   Collection B     │  │
│  │ ┌──────┐ ┌──────┐ │         │ ┌──────┐           │  │
│  │ │ Doc1 │ │ Doc2 │ │         │ │ Doc3 │           │  │
│  │ └──────┘ └──────┘ │         │ └──────┘           │  │
│  └───────────────────┘         └────────────────────┘  │
│                                                        │
│  ┌──────────────────────────────────────────────────┐  │
│  │      Configs (LLMs, Parsers, Embedders)          │  │
│  └──────────────────────────────────────────────────┘  │
└────────────────────────────────────────────────────────┘

• Absolute Isolation: Workspaces contain everything. All uploaded documents, collection indices, prompt templates, and chat threads are structurally separated. Cross-workspace querying is impossible by design.
• API Scopes: Access keys are bound natively to your active Workspace context. A request carried out with a key can never locate or influence data from another workspace.
• Dual Run State Capabilities: Inside a workspace, you can operate in two distinct modes:
  • Stateful Modes: Indexing files permanently into highly structured, searchable Collections for ongoing conversational RAG.
  • Stateless Modes: Passing files through immediate, transient pipelines to OCR-parse or classify files without saving them to vector databases.

🛠️ Workspace Management

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

Create a Workspace

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

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

Read, List & Update

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

• List Workspaces: Retrieve all active workspaces accessible by your key.
• Read Workspace: Fetch the complete metadata and configuration for a specific ID.
• Update Workspace: Patch workspace names or configuration defaults via shallow merging.

Delete a Workspace

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/w/{workspace_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"