Skip to main content
POST
Create a new workspace

Authorizations

hq-session
string
cookie
required

Browser session cookie set by sign-in. Web SPA only; not for PAT/OAuth integrators.

Body

application/json
invite_code
string
required

Invite code (inv-…). Required and consumed single-use - creating a workspace is invite-gated even for an already-authenticated member, so a signed-in user can't mint workspaces without an invite to spend.

workspace_name
string
required

Display name for the new workspace; the URL slug derives from it.

website
string | null

Optional company website / domain; seeds the brand-style crawl. Falls back to the caller's email domain (unless free-mail) when omitted.

Response

Workspace created; session re-scoped to it (fresh cookie set)

name
string
required

Display name.

onboarded
boolean
required

false for a fresh create (the SPA lands the owner on /onboarding); on an idempotent replay it reflects the tenant's real onboarding state.

slug
string
required

Slug of the freshly created workspace.