Skip to main content
POST
Create a workspace and send an OTP verification email

Body

application/json
workspace_name
string
required

Display name for the new workspace.

Required string length: 1 - 255
Example:

"Acme Corp"

email
string<email>
required

Email address for the workspace owner. An OTP will be sent here.

Maximum string length: 320
Example:

"dev@acmecorp.com"

api_key_name
string
default:default

Label for the first API key.

Required string length: 1 - 255
Example:

"default"

Response

Successful Response

workspace
WorkspaceOut · object
required
api_key
ApiKeyCreated · object
required

Returned once at creation time -- includes the plaintext secret.

otp_delivered
boolean
default:true

Whether the verification email was actually dispatched. When false, the returned key is inert and cannot be verified — email delivery failed (or is not configured), so retry signup once a working inbox is reachable.