---
title: "Create workspace"
method: POST
path: "/documents/workspaces-create"
tags: ["Document AI — DMS"]
---

# Create workspace

`POST /documents/workspaces-create`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/workspaces-create`
- Auth: HTTP bearer

Create a new workspace to organize documents by client, project, or topic. Optional fields include security tier (standard, business, compliance; legacy alias confidential → business) and AI-DMS settings. After creation, use List...

## Request body

- object
  - `name` string, required: Workspace name (required, must not be empty).
  - `description` string: Description of the workspace.
  - `type` string, required: Business workspace type slug (required). Examples: `ablage`, `abinvoice`, `department`, `agentur`, `akte`, `quote`, `Archive`, `order`, `ausschreibung`, `bauprojekt` — 107 types total (use the workspace type picker in the app or MCP workspace tools; invalid values return `allowed_types_hint`).
  - `workspace_tier` 'standard' | 'business' | 'compliance': Security tier: `standard` (no recycle bin), `business` (recycle bin + sharing), `compliance` (business + compliance watermark). Legacy alias: `confidential` is accepted and normalized to `business`.
  - `is_revision_secure` boolean: Enable revision-safe mode (WORM protection). Once activated, cannot be disabled. Requires PaperOffice EU Cloud.
  - `retention_years` integer: Retention period in years (default: 10 years, GoBD-compliant).
  - `ai_dms_mode` 'disabled' | 'basic' | 'premium' | 'ultra': AI-DMS processing mode for the workspace. Allowed: disabled, basic, premium, ultra. Default: disabled.
  - `storage_mode` 'cloud' | 'byos': Storage mode: 'cloud' (PaperOffice EU Cloud) or 'byos' (Bring Your Own Storage). After creation, not deletable.
  - `storage_mount_id` integer: Identify the Storage Mounts for BYOS Mode.
  - `storage_mount_path` string: Path on the Storage Mount for BYOS mode.
  - `default_locale` string: Default language/region in the Format 'de:DE', 'en:US' etc.
  - `image` string: Image URL for the workspace.
  - `priority` integer: LEGACY queue weight (numeric). Prefer processing_lane (Start-SLA). If processing_lane is set, the lane wins. Do not use as the public SLA product. For workspaces: legacy plan-gated weight 100–999 — not Start-SLA; use default_processing_lane.
  - `is_default` boolean: Mark as standard workspace.
  - `is_stealth` boolean: Workspace im Stealth-Modus (versteckt).
  - `is_archived` boolean: Archive workspace.
  - `workspace_password` string: Password for the workspace access.
  - `color` string: Color code the workspace.
  - `icon` string: Icon the workspace.
  - `tags` string[]: Tags for the workspace.
  - `contact_salutation` string: Salutation Ansprechpartners.
  - `contact_firstname` string: First name of the contact person.
  - `contact_lastname` string: Last name of the contact person.
  - `contact_email` string: E-Mail the Ansprechpartners.
  - `contact_phone` string: Telefon the Ansprechpartners.
  - `company_name` string: Firmenname.
  - `address_street` string: Street address.
  - `address_zip` string: Postal code.
  - `address_city` string: City.
  - `address_country` string: Country code (ISO 3166-1 alpha-2).
  - `metadata` object: Additional metadata as JSON object.
  - `default_processing_lane` 'no_sla' | 'sla_24h' | 'sla_12h' | 'sla_6h' | 'sla_1h' | 'instant': Workspace default Start-SLA. Used when Auto AI-DMS omits processing_lane. Alias: processing_lane.
  - `processing_lane` 'no_sla' | 'sla_24h' | 'sla_12h' | 'sla_6h' | 'sla_1h' | 'instant': Start-SLA lane (wait-to-start guarantee, not completion). Values: no_sla (fair use ×1), sla_24h (×1.5), sla_12h (×2), sla_6h (×3), sla_1h (×4), instant (×5 interactive start). Prefer this over legacy numeric priority. If omitted: workspace default_processing_lane, else no_sla.

## Response `200`

Success

- object: Create a new workspace
  - `status` 'success' | 'error', required: Operation result status
  - `message` string: Human-readable status message
  - `id` integer: ID of the newly created workspace
  - `workspace_tier` 'standard' | 'confidential' | 'compliance': Workspace security level
  - `processing_time` string: Request processing time (e.g. "123.45ms")

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)