Skip to main content
POST
Create a workspace

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Body

application/json
name
string
required

Required human-readable workspace name. Leading and trailing ASCII whitespace is removed. The remaining name must not be empty, must contain at most 128 Unicode code points, and must not contain control or directional formatting characters. The name must be unique within the tenant.

Required string length: 1 - 128
Pattern: ^(?![\u0009-\u000D\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028-\u2029\u202F\u205F\u3000]*$)[\u0009-\u000D\u0020]*[^\u0000-\u0020\u007F-\u009F\u061C\u200E-\u200F\u2028-\u202E\u2066-\u2069](?:[^\u0000-\u001F\u007F-\u009F\u061C\u200E-\u200F\u2028-\u202E\u2066-\u2069]*[^\u0000-\u0020\u007F-\u009F\u061C\u200E-\u200F\u2028-\u202E\u2066-\u2069])?[\u0009-\u000D\u0020]*$

Response

Workspace created

workspace_id
string<uuid>
required

Unique workspace identifier

name
string
required

The caller-supplied workspace name.

request_id
string
required

Unique request identifier

tenant_id
string<uuid>
required

Tenant identifier resolved by the server.