NAnace
Workspaces

Update a workspace

Changes workspace settings, or renames it with a name-only request. Send name separately from settings. Only the creator or owner-account admins and owners may rename. Names are unique per account ignoring case. Access labels cannot change. Free.

patch/v1/workspaces/{id}

Request

Path parameters

idstring required

The workspace's workspace_id.

Request body

knowledge_graphobject

Replaces the block whole: auto_build, exclude_path_prefixes, exclude_categories.

currencyobject nullable

{"default": "USD"}, or null for none.

global_contextstring

Background for every search and QA turn; "" clears it.

namestring

New display name. Trimmed; no control characters. Send separately from settings.

Response

The updated workspace.

workspace_idstring required

The id every workspace route takes, and the workspace_id of its files' workspace_file sources.

namestring required

The workspace's current display name. Rename it with a name-only PATCH /v1/workspaces/{id}; its workspace_id stays the same.

owner_user_idstring nullable

The account member who created it.

knowledge_graphobject

auto_build (default false), exclude_path_prefixes and exclude_categories.

currencyobject nullable

default, the ISO 4217 code ingestion reads for an ambiguous symbol.

domain_idstring

The pinned version of the domain the workspace sorts its files into.

domain_slugstring

The slug of that domain, such as generic.

domain_versioninteger

The version of the domain the workspace is pinned to.

global_contextstring

Background every search and QA turn without its own context runs with.

config_versioninteger
status'active' | 'deleting' | 'unavailable' required

unavailable only in a list: the document service has no workspace by this id, so reading it is 404 workspace_not_found. Delete it to take it off the list.

created_atstring date-time
updated_atstring date-time

Changes

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