workspaces

update_workspace

Change a workspace's mutable configuration. Cost class: fast.

Presence-aware, and whole-block: an omitted field is left alone, a supplied one replaces its block entirely. Read the workspace, edit the block, send it back — partial blocks fall back to the schema defaults, which is how a caller flipping auto_build would otherwise wipe its own exclusion rules.

Graph builds are explicit by default: a build happens when POST /v1/workspaces/{id}/knowledge-graph/builds asks for one. Turning knowledge_graph.auto_build on hands that trigger to ingestion instead, for a workspace that wants a graph over everything it ingests and accepts the bill for one per ingestion. Either way a build already in flight is unaffected — cancel it if that is what you meant.

currency follows the same whole-block rule, so {} is how its policy is cleared. Setting currency.default changes how the next ingestion reads amounts marked with a symbol that names several currencies ($, ¥, kr); amounts already extracted as ambiguous stay that way until their file is re-ingested, because the catalog records what a past extraction could read.

Ordinary workspace names are mutable without changing identity or storage; platform-provisioned workspace names remain fixed. The domain and label list are deliberately not mutable here. They are part of the versioned config record stamped onto every derived artifact, so editing them in place would re-describe material that was derived under the old one.

patch/v1/workspaces/{workspace_id}

Request

Path parameters

workspace_idstring uuid required

Workspace identifier.

Request body

global_contextstring nullable

The workspace's new global context, or omitted to leave it unchanged; "" clears it. Standing background for every query in this workspace — how its journals are keyed, which entity it covers, what an auditor already knows. A je-testing or search request that omits context runs with this text; a request that sends context replaces it for that run, and "" runs with none. Empty means none. Surrounding whitespace is stripped.

namestring

New display name for an ordinary workspace. Platform-provisioned names are fixed. Omit to keep the current name; null is not accepted.

Response

Successful Response

config_versioninteger required
created_atstring date-time required
domain_idstring uuid required
domain_slugstring required
domain_versioninteger required
global_contextstring

Standing background for every query in this workspace — how its journals are keyed, which entity it covers, what an auditor already knows. A je-testing or search request that omits context runs with this text; a request that sends context replaces it for that run, and "" runs with none. Empty means none. Surrounding whitespace is stripped.

namestring required
owner_user_idstring uuid nullable required

The console user who owns the workspace, or null for an organization-owned integration workspace.

purpose'perception_playground'

Why the platform provisioned a workspace nobody asked for.

A purposed workspace is platform-managed: it is created on a person's behalf and it refuses deletion, so a caller can tell from a list response which row will answer 409 rather than discovering it by trying.

share_countinteger required

Number of users explicitly granted workspace access; excludes the owner.

status'active' | 'deleting' required

Lifecycle states visible on the API surface.

deleted is a final internal state; a deleted workspace never appears in any list or get response — it is as if it never existed.

updated_atstring date-time required
workspace_idstring uuid required

Changes

No recorded changes to this operation across all 2 revisions of this API.