Workspaces

List Workspaces

List user-facing (kind=data) workspaces in the current organization. Guideline and simulation workspaces are excluded.

Query parameters

• include_statsbooleanoptional

  Include document/proposal counts

Headers

• X-Organization-IDstringoptional
• X-Workspace-IDstringoptional

Create Workspace

Create a new workspace in the current organization. Type B: the max_workspaces quota is enforced by require_access.

Headers

• X-Organization-IDstringoptional

Request body

• namestringrequired
• descriptionstringoptional

Get Workspace

Get a specific workspace by ID.

Path parameters

• workspace_idstring (uuid)required

Query parameters

• include_statsbooleanoptional

Headers

• X-Organization-IDstringoptional
• X-Workspace-IDstringoptional

Update Workspace

Update a workspace's name or description. Type B, no cost; an admin can disable it via operation_configs.is_active.

Path parameters

• workspace_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Request body

• namestringoptional
• descriptionstringoptional

Delete Workspace

Delete a workspace and all its data. The default workspace cannot be deleted.

Path parameters

• workspace_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Upload Workspace Logo

Replace a workspace's logo with the uploaded image. The multipart field is file. Any format Pillow can decode is accepted; the stored form fits a 384x128 box with its aspect ratio kept.

Path parameters

• workspace_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Form fields

• filefilerequired

Remove Workspace Logo

Remove a workspace's own logo. The default workspace goes back to the company logo; any other goes back to none. Idempotent.

Path parameters

• workspace_idstring (uuid)required

Headers

• X-Organization-IDstringoptional