Document AI — DMS

Create workspace

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...

post/documents/workspaces-create

Request

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

Request body

namestring required

Workspace name (required, must not be empty).

descriptionstring

Description of the workspace.

typestring 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_secureboolean

Enable revision-safe mode (WORM protection). Once activated, cannot be disabled. Requires PaperOffice EU Cloud.

retention_yearsinteger

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_idinteger

Identify the Storage Mounts for BYOS Mode.

storage_mount_pathstring

Path on the Storage Mount for BYOS mode.

default_localestring

Default language/region in the Format 'de:DE', 'en:US' etc.

imagestring

Image URL for the workspace.

priorityinteger

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_defaultboolean

Mark as standard workspace.

is_stealthboolean

Workspace im Stealth-Modus (versteckt).

is_archivedboolean

Archive workspace.

workspace_passwordstring

Password for the workspace access.

colorstring

Color code the workspace.

iconstring

Icon the workspace.

tagsstring[]

Tags for the workspace.

contact_salutationstring

Salutation Ansprechpartners.

contact_firstnamestring

First name of the contact person.

contact_lastnamestring

Last name of the contact person.

contact_emailstring

E-Mail the Ansprechpartners.

contact_phonestring

Telefon the Ansprechpartners.

company_namestring

Firmenname.

address_streetstring

Street address.

address_zipstring

Postal code.

address_citystring

City.

address_countrystring

Country code (ISO 3166-1 alpha-2).

metadataobject

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

Success

status'success' | 'error' required

Operation result status

messagestring

Human-readable status message

idinteger

ID of the newly created workspace

workspace_tier'standard' | 'confidential' | 'compliance'

Workspace security level

processing_timestring

Request processing time (e.g. "123.45ms")

Changes

No recorded changes to this operation across all 1 revision of this API.