Docmost Octri Preview
POST/auth/setup

Set up a workspace and admin account

Creates the initial workspace and its first admin account. Supply name, email, and password; hostname can set the workspace subdomain, and workspaceName can set its display name. The hostname and workspace name are generated or defaulted when omitted.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Initial workspace and admin account details.

emailstringrequired
Admin email address.
hostnamestringoptional
Subdomain identifier for the workspace (e.g. `my-team`). Alphanumeric and hyphens only. If omitted, generated automatically.
namestringrequired
Display name for the admin user.
passwordstringrequired
Admin password. Must be at least 8 characters.
workspaceNamestringoptional
Name for the workspace. If omitted, a default name is used.

2 status codes
200Returns a response confirming that the workspace was created.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
403Returned when workspace setup has already been completed.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned if workspace setup has already been completed. name, email, and password are required; email must use a valid email format, and password must be 8 to 70 characters. If provided, hostname must be 4 to 50 alphanumeric characters or hyphens.