> This page is for version 0.10.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo-helix/latest/llms.txt
> - 0.10: https://docs.nvidia.com/nemo-helix/v0.10/llms.txt
> - 0.9: https://docs.nvidia.com/nemo-helix/v0.9/llms.txt
> - 0.8: https://docs.nvidia.com/nemo-helix/v0.8/llms.txt
> - 0.7: https://docs.nvidia.com/nemo-helix/v0.7/llms.txt
> - 0.6: https://docs.nvidia.com/nemo-helix/v0.6/llms.txt
> - 0.5: https://docs.nvidia.com/nemo-helix/v0.5/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo-helix/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo-helix/_mcp/server.

# Create a new workspace

POST http://localhost:8080/apis/entities/v2/workspaces
Content-Type: application/json

Create a new workspace.

The creator is automatically granted Admin role on the workspace.
By default, this endpoint waits for the Admin role to propagate before returning.
Use `wait_role_propagation=false` to skip waiting (useful for bulk operations).

Names beginning with `sample-` are reserved for the Agents sample flow.

Example:

```
POST /apis/entities/v2/workspaces
{
    "name": "ml-team",
    "description": "Machine Learning Team workspace"
}
```

Reference: https://docs.nvidia.com/nemo-helix/documentation/reference/api-reference/entity-store/create-workspace-apis-entities-v-2-workspaces-post

## Request

### Query parameters

- `wait_role_propagation` (boolean, optional, default: true) — If true, wait for Admin role to propagate before returning (default: true). Set to false for bulk operations.

### Body (application/json)

This endpoint expects a WorkspaceInput.

- `name` (string, required) — Workspace name (unique identifier). Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).
- `description` (string, optional) — Optional description of the workspace

## Response

### 201

Successful Response

- `id` (string, required) — System-generated UUID
- `name` (string, required) — Workspace name (user-provided)
- `created_at` (datetime, required) — Timestamp of workspace creation
- `updated_at` (datetime, required) — Timestamp of last workspace update
- `description` (string, optional) — Optional description
- `created_by` (string, optional) — Principal id for workspace creator
- `updated_by` (string, optional) — Principal id for last workspace update

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (map from string to any, optional)

### ValidationErrorLocItems

- string
- integer

## Examples

**Request**

```json
{
  "name": "ml-team"
}
```

**Response**

```json
{
  "id": "string",
  "name": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "description": "string",
  "created_by": "string",
  "updated_by": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8080/apis/entities/v2/workspaces"

payload = { "name": "ml-team" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:8080/apis/entities/v2/workspaces';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"ml-team"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```