NAnace
Workspaces

Create a workspace

A new workspace in this key's account. Free; creating one uploads nothing. The knowledge graph is built only when asked unless knowledge_graph.auto_build is true. The name must be unique in the account, ignoring case. Not idempotent: a retried create that already went through answers 409.

post/v1/workspaces

Request

Request body

namestring required

Unique among the account's live workspaces, ignoring case. Leading and trailing spaces are trimmed.

domain_slugstring

The published domain the workspace sorts its files into: generic, the general-purpose default; a domain your account published; or one Nace provides. The workspace pins the newest published version at the time. Left out, generic. Can't change later. A slug that names no published domain you can use is 422 invalid_request.

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.

Response

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