Skip to navigation

Create Workspace

Create a new workspace owned by the current user.

Workspaces are the top-level container for all resources (workflows, voices, dictionary entries, members). Every resource is scoped to exactly one workspace via the X-Workspace-Id header on subsequent requests.

The authenticated user becomes the workspace owner and is automatically added as an admin member. An optional slug (1–50 characters, lowercase kebab-case) can be supplied for a human-readable workspace identifier; if omitted, one is auto-generated from name. Returns 409 if the slug is already taken, 422 if the slug format is invalid or uses a reserved word.

The number of workspaces a user may own is plan-gated. Attempting to exceed the limit returns 402.

Authentication

AuthorizationBearer
Clerk JWT token

Request

This endpoint expects an object.
namestringRequired1-200 characters

Human-readable workspace name (1–200 characters, non-blank).

slugstring or nullOptional<=512 characters

Optional URL-safe identifier (lowercase kebab-case, 1–50 characters). Auto-generated from name if omitted. Returns 409 if taken, 422 if invalid or reserved.

color_idxintegerOptionalDefaults to 0

Index into the workspace color palette (0–6).

Response

Successful Response
dataobject
metaobject

Errors

409
Conflict Error
422
Unprocessable Entity Error