workspaces

create_workspace

Provision a new workspace. Cost class: fast.

Every field has a sensible default so a caller who knows nothing creates a working workspace with just a name. The workspace is immediately usable for ingestion after this call; no activation step is needed.

Retry with the same Idempotency-Key and body after an interrupted response.

Args: session: Database session. caller: The authenticated tenant who will own the workspace. request: Creation parameters.

Returns: The created workspace with a 201 status.

Raises: PlatformError: domain_not_found or domain_not_published.

post/v1/workspaces

Request

Headers

Idempotency-Keystring nullable

Replaying a request with the same key returns the original job with 200, never a second job. The key is kept with the job for replay and never cleared, so it must not contain personal data.

Request body

namestring required
domain_slugstring

Domain vocabulary. Resolved to the latest published version unless pinned.

domain_versioninteger nullable

Pin a specific domain version. Omit to take the latest published.

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.

Response

Successful Response

workspace_idstring uuid required
owner_user_idstring uuid nullable required

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

share_countinteger required

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

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

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

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.

created_atstring date-time required
updated_atstring date-time required

Changes

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