Create a workspace

POST

/v2/workspaces

This endpoint allows clients to create a workspace with specific characteristics.

Usage notes

Set NoDuplicates to true to prevent the creation of a workspace with a name that already exists.

Usage scenarios

Initial setup: Useful for users setting up a new workspace after signing up.
Project separation: Helps in creating separate workspaces for different projects or teams.

Best practices

Check for existing names: Before setting noDuplicates to true, make sure to search for existing workspace names to avoid conflicts.
Consistent naming conventions: Adopt a consistent naming convention for workspaces to ensure clarity and avoid confusion.

This endpoint allows clients to create a workspace with specific characteristics. ### Usage notes - Set **NoDuplicates** to **true** to prevent the creation of a workspace with a name that already exists. ### Usage scenarios - **Initial setup**: Useful for users setting up a new workspace after signing up. - **Project separation**: Helps in creating separate workspaces for different projects or teams. ### Best practices - **Check for existing names**: Before setting `noDuplicates` to true, make sure to search for existing workspace names to avoid conflicts. - **Consistent naming conventions**: Adopt a consistent naming convention for workspaces to ensure clarity and avoid confusion.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.

namestringRequired

Name of the new workspace.

noDuplicatesbooleanOptional

Set to true to avoid creating a workspace with a duplicate name.

Response

The response body.

Workspace detailsobject

object

$	curl -X POST https://api.sigmacomputing.com/v2/workspaces \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Marketing Analytics Workspace"
>	}'

1	{
2	"createdAt": "2024-01-15T09:30:00Z",
3	"createdBy": "jane.doe@company.com",
4	"name": "Marketing Analytics Workspace",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"updatedBy": "jane.doe@company.com",
7	"workspaceId": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
8	"workspaceUrlId": "4f7g9h2j"
9	}